One Logo Pool Ball
AVFoundation · IOS API REFERENCE

AVPlayerInterstitialEvent

class · iOS 15.0+ · SDK 27.1

class AVPlayerInterstitialEvent

Members (43)

init · iOS 16.0+

init

TypeScript
static initPrimaryItemDate(primaryItem: AVPlayerItem, date: globalThis.Date): AVPlayerInterstitialEvent
Swift declaration
convenience init(primaryItem: AVPlayerItem, date: Date)
init · iOS 16.0+

init

TypeScript
static initPrimaryItemTime(primaryItem: AVPlayerItem, time: _CoreMedia_CMTime): AVPlayerInterstitialEvent
Swift declaration
convenience init(primaryItem: AVPlayerItem, time: CMTime)
get · iOS 16.0+

alignsResumptionWithPrimarySegmentBoundary

TypeScript
get alignsResumptionWithPrimarySegmentBoundary(): boolean
Swift declaration
var alignsResumptionWithPrimarySegmentBoundary: Bool { get set }
set · iOS 16.0+

alignsResumptionWithPrimarySegmentBoundary

TypeScript
set alignsResumptionWithPrimarySegmentBoundary(value: boolean)
Swift declaration
var alignsResumptionWithPrimarySegmentBoundary: Bool { get set }
get · iOS 16.0+

alignsStartWithPrimarySegmentBoundary

TypeScript
get alignsStartWithPrimarySegmentBoundary(): boolean
Swift declaration
var alignsStartWithPrimarySegmentBoundary: Bool { get set }
set · iOS 16.0+

alignsStartWithPrimarySegmentBoundary

TypeScript
set alignsStartWithPrimarySegmentBoundary(value: boolean)
Swift declaration
var alignsStartWithPrimarySegmentBoundary: Bool { get set }
get · iOS 16.4+

assetListResponse

TypeScript
get assetListResponse(): (NativeMap<unknown, SDKHandle>) | null
Swift declaration
var assetListResponse: [AnyHashable : any Sendable]? { get }
get · iOS 18.0+

contentMayVary

TypeScript
get contentMayVary(): boolean
Swift declaration
var contentMayVary: Bool { get set }
set · iOS 18.0+

contentMayVary

TypeScript
set contentMayVary(value: boolean)
Swift declaration
var contentMayVary: Bool { get set }
get · iOS 16.0+

cue

TypeScript
get cue(): AVPlayerInterstitialEvent_Cue
Swift declaration
var cue: AVPlayerInterstitialEvent.Cue { get set }
set · iOS 16.0+

cue

TypeScript
set cue(value: AVPlayerInterstitialEvent_Cue)
Swift declaration
var cue: AVPlayerInterstitialEvent.Cue { get set }
get · iOS 15.0+

date

TypeScript
get date(): (globalThis.Date) | null
Swift declaration
var date: Date? { get set }
set · iOS 15.0+

date

TypeScript
set date(value: (globalThis.Date) | null)
Swift declaration
var date: Date? { get set }
get · iOS 15.0+

identifier

TypeScript
get identifier(): string
Swift declaration
var identifier: String { get set }
set · iOS 15.0+

identifier

TypeScript
set identifier(value: string)
Swift declaration
var identifier: String { get set }
get · iOS 18.0+

plannedDuration

TypeScript
get plannedDuration(): _CoreMedia_CMTime
Swift declaration
var plannedDuration: CMTime { get set }
set · iOS 18.0+

plannedDuration

TypeScript
set plannedDuration(value: _CoreMedia_CMTime)
Swift declaration
var plannedDuration: CMTime { get set }
get · iOS 15.0+

playoutLimit

TypeScript
get playoutLimit(): _CoreMedia_CMTime
Swift declaration
var playoutLimit: CMTime { get set }
set · iOS 15.0+

playoutLimit

TypeScript
set playoutLimit(value: _CoreMedia_CMTime)
Swift declaration
var playoutLimit: CMTime { get set }
get · iOS 15.0+

primaryItem

TypeScript
get primaryItem(): (AVPlayerItem) | null
Swift declaration
weak var primaryItem: AVPlayerItem? { get }
get · iOS 15.0+

restrictions

TypeScript
get restrictions(): AVPlayerInterstitialEvent_Restrictions
Swift declaration
var restrictions: AVPlayerInterstitialEvent.Restrictions { get set }
set · iOS 15.0+

restrictions

TypeScript
set restrictions(value: AVPlayerInterstitialEvent_Restrictions)
Swift declaration
var restrictions: AVPlayerInterstitialEvent.Restrictions { get set }
get · iOS 15.0+

resumptionOffset

TypeScript
get resumptionOffset(): _CoreMedia_CMTime
Swift declaration
var resumptionOffset: CMTime { get set }
set · iOS 15.0+

resumptionOffset

TypeScript
set resumptionOffset(value: _CoreMedia_CMTime)
Swift declaration
var resumptionOffset: CMTime { get set }
get · iOS 26.4+

scheduleIdentifier

TypeScript
get scheduleIdentifier(): (string) | null
Swift declaration
var scheduleIdentifier: String? { get }
get · iOS 26.0+

skipControlLocalizedLabelBundleKey

TypeScript
get skipControlLocalizedLabelBundleKey(): (string) | null
Swift declaration
var skipControlLocalizedLabelBundleKey: String? { get set }
set · iOS 26.0+

skipControlLocalizedLabelBundleKey

TypeScript
set skipControlLocalizedLabelBundleKey(value: (string) | null)
Swift declaration
var skipControlLocalizedLabelBundleKey: String? { get set }
get · iOS 26.0+

skipControlTimeRange

TypeScript
get skipControlTimeRange(): _CoreMedia_CMTimeRange
Swift declaration
var skipControlTimeRange: CMTimeRange { get set }
set · iOS 26.0+

skipControlTimeRange

TypeScript
set skipControlTimeRange(value: _CoreMedia_CMTimeRange)
Swift declaration
var skipControlTimeRange: CMTimeRange { get set }
get · iOS 18.0+

supplementsPrimaryContent

TypeScript
get supplementsPrimaryContent(): boolean
Swift declaration
var supplementsPrimaryContent: Bool { get set }
set · iOS 18.0+

supplementsPrimaryContent

TypeScript
set supplementsPrimaryContent(value: boolean)
Swift declaration
var supplementsPrimaryContent: Bool { get set }
get · iOS 15.0+

templateItems

TypeScript
get templateItems(): Array<AVPlayerItem>
Swift declaration
var templateItems: [AVPlayerItem] { get set }
set · iOS 15.0+

templateItems

TypeScript
set templateItems(value: Array<AVPlayerItem>)
Swift declaration
var templateItems: [AVPlayerItem] { get set }
get · iOS 15.0+

time

TypeScript
get time(): _CoreMedia_CMTime
Swift declaration
var time: CMTime { get set }
set · iOS 15.0+

time

TypeScript
set time(value: _CoreMedia_CMTime)
Swift declaration
var time: CMTime { get set }
get · iOS 18.0+

timelineOccupancy

TypeScript
get timelineOccupancy(): AVPlayerInterstitialEvent_TimelineOccupancy
Swift declaration
var timelineOccupancy: AVPlayerInterstitialEvent.TimelineOccupancy { get set }
set · iOS 18.0+

timelineOccupancy

TypeScript
set timelineOccupancy(value: AVPlayerInterstitialEvent_TimelineOccupancy)
Swift declaration
var timelineOccupancy: AVPlayerInterstitialEvent.TimelineOccupancy { get set }
get · iOS 15.0+

userDefinedAttributes

TypeScript
get userDefinedAttributes(): NativeMap<unknown, SDKHandle>
Swift declaration
var userDefinedAttributes: [AnyHashable : any Sendable] { get set }
set · iOS 15.0+

userDefinedAttributes

TypeScript
set userDefinedAttributes(value: NativeMap<unknown, SDKHandle>)
Swift declaration
var userDefinedAttributes: [AnyHashable : any Sendable] { get set }
get · iOS 16.0+

willPlayOnce

TypeScript
get willPlayOnce(): boolean
Swift declaration
var willPlayOnce: Bool { get set }
set · iOS 16.0+

willPlayOnce

TypeScript
set willPlayOnce(value: boolean)
Swift declaration
var willPlayOnce: Bool { get set }
init · iOS 15.0+

init

TypeScript
static initPrimaryItemIdentifierDateTemplateItemsRestrictionsResumptionOffsetPlayoutLimitUserDefinedAttributes(primaryItem: AVPlayerItem, identifier: (string) | null, date: globalThis.Date, templateItems: Array<AVPlayerItem>, restrictions?: AVPlayerInterstitialEvent_Restrictions, resumptionOffset?: _CoreMedia_CMTime, playoutLimit?: _CoreMedia_CMTime, userDefinedAttributes?: Record<string, unknown>): AVPlayerInterstitialEvent
Swift declaration
convenience init(primaryItem: AVPlayerItem, identifier: String?, date: Date, templateItems: [AVPlayerItem], restrictions: AVPlayerInterstitialEvent.Restrictions = [], resumptionOffset: CMTime = .indefinite, playoutLimit: CMTime = .invalid, userDefinedAttributes: [String : Any] = [:])

AVPlayerInterstitialEvent initializer by date - Parameters: - primaryItem: The AVPlayerItem playing the primary content, against which the interstitial event will be scheduled. The primaryItem must have an AVAsset that provides an intrinsic mapping from its timeline to real-time dates. - identifier: A persistent identifier for the event. - date: The date within the date range of the primary item at which playback of the primary content should be temporarily suspended and the interstitial items played. - templateItems: An array of AVPlayerItems with configurations that will be reproduced for the playback of interstitial content. - restrictions: Indicates restrictions on the use of end user playback controls that are imposed by the event. - resumptionOffset: Specifies the offset in time at which playback of the primary item should resume after interstitial playback has finished. Definite numeric values are supported. The value .indefinite can also be used, in order to specify that the effective resumption time offset should accord with the wallclock time elapsed during interstitial playback. - playoutLimit: Specifies the offset from the beginning of the interstitial at which interstitial playback should end, if the interstitial asset(s) are longer. Pass a positive numeric value, or .invalid to indicate no playout limit. - userDefinedAttributes: Storage for attributes defined by the client or the content vendor. Attribute names should begin with X- for uniformity with server insertion.

init · iOS 15.0+

init

TypeScript
static initPrimaryItemIdentifierTimeTemplateItemsRestrictionsResumptionOffsetPlayoutLimitUserDefinedAttributes(primaryItem: AVPlayerItem, identifier: (string) | null, time: _CoreMedia_CMTime, templateItems: Array<AVPlayerItem>, restrictions?: AVPlayerInterstitialEvent_Restrictions, resumptionOffset?: _CoreMedia_CMTime, playoutLimit?: _CoreMedia_CMTime, userDefinedAttributes?: Record<string, unknown>): AVPlayerInterstitialEvent
Swift declaration
convenience init(primaryItem: AVPlayerItem, identifier: String?, time: CMTime, templateItems: [AVPlayerItem], restrictions: AVPlayerInterstitialEvent.Restrictions = [], resumptionOffset: CMTime = .indefinite, playoutLimit: CMTime = .invalid, userDefinedAttributes: [String : Any] = [:])

AVPlayerInterstitialEvent initializer by time - Parameters: - primaryItem: The AVPlayerItem playing the primary content, against which the interstitial event will be scheduled. - identifier: A persistent identifier for the event. - time: The time within the duration of the primary item at which playback of the primary content should be temporarily suspended and the interstitial items played. - templateItems: An array of AVPlayerItems with configurations that will be reproduced for the playback of interstitial content. - restrictions: Indicates restrictions on the use of end user playback controls that are imposed by the event. - resumptionOffset: Specifies the offset in time at which playback of the primary item should resume after interstitial playback has finished. Definite numeric values are supported. The value .indefinite can also be used, in order to specify that the effective resumption time offset should accord with the wallclock time elapsed during interstitial playback. - playoutLimit: Specifies the offset from the beginning of the interstitial at which interstitial playback should end, if the interstitial asset(s) are longer. Pass a positive numeric value, or .invalid to indicate no playout limit. - userDefinedAttributes: Storage for attributes defined by the client or the content vendor. Attribute names should begin with X- for uniformity with server insertion.

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

AVPlayerInterstitialEvent.init()

inherited init: cannot prove legal (class declares 4 custom initializers)

All AVFoundation types →