MediaBreakSchedule Class

  • Reference

Definition

Namespace:
Windows.Media.Playback
Edit

Represents a set of MediaBreak objects associated with a MediaPlaybackItem and the positions within the playback of the item that the media breaks are played.

public ref class MediaBreakSchedule sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 196608)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class MediaBreakSchedule final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 196608)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class MediaBreakSchedule
Public NotInheritable Class MediaBreakSchedule
Inheritance
Object Platform::Object IInspectable MediaBreakSchedule
Attributes
ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family
Windows 10 Anniversary Edition (introduced in 10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v3.0)

Remarks

Get the media break schedule for a media item by accessing the BreakSchedule property of the MediaPlaybackItem object.

For how-to guidance for working with media breaks, see Create, schedule, and manage media breaks.

Properties

MidrollBreaks

Gets the schedule's current list of MediaBreak objects that will be played at a point during the playback of the MediaPlaybackItem with which the MediaBreakSchedule is associated.
PlaybackItem

Gets the MediaPlaybackItem with which the MediaBreakSchedule is associated.
PostrollBreak

Gets or sets the MediaBreak to be played after the MediaPlaybackItem associated with the MediaBreakSchedule plays.
PrerollBreak

Gets or sets the MediaBreak to be played before the MediaPlaybackItem associated with the MediaBreakSchedule plays.

Methods

InsertMidrollBreak(MediaBreak)

Adds a MediaBreak to the schedule that will be played at a point during the playback of the MediaPlaybackItem with which the MediaBreakSchedule is associated.
RemoveMidrollBreak(MediaBreak)

Removes a midroll MediaBreak from the MediaBreakSchedule.

Events

ScheduleChanged

Occurs when the MediaBreakSchedule changes.

Applies to

See also