Protocols
The following protocols are available globally.
-
Handling all ad events
See moreDeclaration
Swift
public protocol AdEventHandlerDelegate : AnyObject -
Undocumented
See moreDeclaration
Swift
public protocol FLAdEventHandler : AnyObject -
Undocumented
See moreDeclaration
Swift
public protocol AdEventSeekIntervalAdaptor : AnyObject -
Undocumented
See moreDeclaration
Swift
public protocol VODAdEventHandler : FLAdEventHandler -
Route every API invocation through the same dispatch queue to prevent data races.
See moreDeclaration
Swift
public protocol LiveAdEventHandler : FLAdEventHandler -
Undocumented
See moreDeclaration
Swift
public protocol LiveAdSeekableRangeDelegate : AnyObject -
Represnts an Ad Break
See moreDeclaration
Swift
public protocol AdBreak -
Represents an Ad
See moreDeclaration
Swift
public protocol Ad -
Represents information about the ads verification provider which will be supplied to the Open Measurement SDK Ad Session.
See moreDeclaration
Swift
public protocol AdVerification -
Represents information about single ad verification resource. For example:
<![CDATA[https://server.com/omid-validation-verification-script-v1.js]]> <![CDATA[parameterstring]]> In the example above:
- the name of the ad verification resource is “JavaScriptResource”
- the value of the ad verification resource is: “https://server.com/omid-validation-verification-script-v1.js”
- the attributes of the ad verification resource are: apiFramework=“omid” and browserOptional=“true”
Declaration
Swift
public protocol VerificationResource -
Represents key VAST properties to be shared with all registered verification providers.
See moreDeclaration
Swift
public protocol VASTProperties -
Represents ad video properties which the verification provider might require.
See moreDeclaration
Swift
public protocol AdVideoProperties -
Represents industry icon object that encapsulates data from the ‘icon’ eleemnt of a VAST Documnet. This graphic overlays a small section of the ad’s video and may be clickable.
See moreDeclaration
Swift
public protocol IndustryIcon -
Represents an icon click fallback image object. Encapsulates the data from the
See moreelement of a VAST document. It is a graphic that is used when a target platform does not support HTML rendering: the information is provided as an image instead. Declaration
Swift
public protocol IconClickFallbackImage -
Undocumented
See moreDeclaration
Swift
public protocol Extensions -
Ad Request interface. Different Ad providers can extend this to define their requests.
Declaration
Swift
public protocol AdRequest -
Ad player delegate
See moreDeclaration
Swift
public protocol AdPlayerDelegate : AdEventHandlerDelegate, EventSendableDelegate, PlayerAuxiliaryEventsDelegate, PlayerControllableDelegate, PlayerMediaTrackSelectableDelegate, PlayerPictureInPicturePlayableDelegate, PlayerTrackAvailabilityDelegate, QueuePlayerDelegate -
Blackout Metadata.
See moreDeclaration
Swift
public protocol BlackoutMetadata : StreamTimelineMetadata -
Configuration for content thumbnail preview image provision by Player
See moreDeclaration
Swift
public protocol ContentThumbnailPreviewConfiguration -
A generic key loading request
Declaration
Swift
public protocol KeyLoadingRequest -
Fairplay key loading request.
See more -
A generic license fetcher.
Declaration
Swift
public protocol LicenseFetcher -
Fairplay license fetcher.
See more -
A generic resource loader delegate.
Declaration
Swift
public protocol LicenseFetcherDelegate -
Delegate for responding to resource loading request for Fairplay Key Requests
See more -
Represents a MediaPlaylistItem.
See moreDeclaration
Swift
public protocol MediaPlaylistItem -
Open Mesurement event delegate
See moreDeclaration
Swift
public protocol OpenMeasurementEventDelegate -
PAL Configuration Parameters
See moreDeclaration
Swift
public protocol PALSessionConfiguration -
Playback Policy Handler.
See moreDeclaration
Swift
public protocol PlaybackPolicyHandler : AnyObject -
The primary player interface
See moreDeclaration
Swift
public protocol Player : EventSendable, PlayerControllable, PlayerMediaTrackSelectable, PlayerNowPlayable, PlayerPictureInPicturePlayable, PlayerPreferable, PlayerQueuable -
Protocol defining the player interface for managing playback queue.
See moreDeclaration
Swift
public protocol PlayerQueuable -
The player interface for controlling player
See moreDeclaration
Swift
public protocol PlayerControllable : AnyObject -
The player interface for media track selection and retrieval
See moreDeclaration
Swift
public protocol PlayerMediaTrackSelectable -
Interface to provide load and playback preferences
See moreDeclaration
Swift
public protocol PlayerPreferable -
Player interface for Picture In Picture playback. These APIs must be used for supporting PiP playback with custom UI ViewController. These APIs are no-op while using AVPlayerViewController.
See moreDeclaration
Swift
public protocol PlayerPictureInPicturePlayable : AnyObject -
Interface to provide NowPlayingInfo.
See moreDeclaration
Swift
public protocol PlayerNowPlayable : AnyObject -
The player controllable delegate
See moreDeclaration
Swift
public protocol PlayerControllableDelegate : AnyObject -
The player media tracks selection delegate
See moreDeclaration
Swift
public protocol PlayerMediaTrackSelectableDelegate -
Undocumented
See moreDeclaration
Swift
public protocol PlayerTrackAvailabilityDelegate -
The player picture in picture delegate
See moreDeclaration
Swift
public protocol PlayerPictureInPicturePlayableDelegate -
Listens to Player’s auxiliary state changes.
See moreDeclaration
Swift
public protocol PlayerAuxiliaryEventsDelegate -
Listens to QueuePlayer changes
See moreDeclaration
Swift
public protocol QueuePlayerDelegate -
Represents the Player Remote Command Controllable
See moreDeclaration
Swift
public protocol PlayerRemoteCommandControllable : AnyObject -
Base protocol for all player preferences.
See moreDeclaration
Swift
public protocol Preference -
An abstract protocol for Metadata associated with
StreamTimelineEventConcrete Metadata types should extend this protocol to create their metadataDeclaration
Swift
public protocol StreamTimelineMetadata -
Stream timeline event contract.
See moreDeclaration
Swift
public protocol EventSendable -
Stream timeline event delegate contract.
See moreDeclaration
Swift
public protocol EventSendableDelegate -
Stream Information Metadata.
See moreDeclaration
Swift
public protocol StreamInformation -
Network Information Metadata.
See moreDeclaration
Swift
public protocol NetworkInformation -
Undocumented
See moreDeclaration
Swift
public protocol StreamStartUpTimeData : AnyObject, CustomDebugStringConvertible
Protocols Reference