APSMediaPlayer

Objective-C

@interface APSMediaPlayer : KRHub <UIViewControllerTransitioningDelegate,
                                   UIViewControllerAnimatedTransitioning,
                                   SFSafariViewControllerDelegate>

Swift

class APSMediaPlayer : KRHub, UIViewControllerTransitioningDelegate, UIViewControllerAnimatedTransitioning, SFSafariViewControllerDelegate

The APSMediaPlayer handles playback and rendering of APSMediaUnits and APSMediaOverlays.

Notifications

  • APSMediaPlayerToggleFullscreenNotification - Posted with each toggle of the fullscreen status
  • APSMediaPlayerWillEnterFullscreenNotification - Posted before the media player enters fullscreen
  • APSMediaPlayerDidEnterFullscreenNotification - Posted after the media player enters fullscreen
  • APSMediaPlayerWillExitFullscreenNotification - Posted before the media player exists fullscreen
  • APSMediaPlayerDidExitFullscreenNotification - Posted after the media player exits fullscreen
  • APSMediaPlayerWasTappedNotification - Posted when the user taps on the media player surface
  • APSMediaPlayerControlsDisplayedNotification - Posted when the video controls bar becomes visible
  • APSMediaPlayerControlsHiddenNotification - Posted when the video controls bar becomes hidden
  • APSMediaPlayerUpdateNotification - Posted every time the internal status of the media player changes. This will happen roughly once every second.
  • APSMediaPlayerUnitFinishedNotification - Posted when a media unit finishes playback, before the remaining playlist units are processed. The userInfo dictionary contains the APSMediaUnit object that just finished playback under the KAPSMediaPlayerCurrentUnit key.
  • APSMediaPlayerErrorNotification - Posted when the media player encounters an error in the process of unit playback. The userInfo dictionary contains the NSError object that represents the error under the kAPSMediaPlayerError key.
  • APSMediaPlayerStatusChangedNotification - Posted when the media player playback state has changed. You can immediately get the new state using the playbackState method of the APSMediaPlayer instance.
  • APSMediaPlayerTrackedEventNotification - Posted when a trackable playback event occurs. The userinfo dictionary contains additional information about the tracked event:
  • the kAPSMediaPlayerEventDescription key returns a string description of the tracked event
  • the kAPSMediaPlayerEventType key returns one of the possible event type constants
  • the kAPSMediaPlayerEventURLs key returns an array of NSURLs that were pinged to track the event
  • the kAPSMediaPlayerCurrentPlaybackTime key returns the playback time when the event was triggered
  • the kAPSMediaPlayerCurrentDuration key returns the total duration of the unit that triggered the event
  • the kAPSMediaPlayerError is present in case the event signals an error
  • the kAPSMediaPlayerSeekStart is present for APSMediaPlayerEventSeeked events and indicates the playback time when the seek started
  • the kAPSMediaPlayerSeekTo is present for APSMediaPlayerEventSeeked events and indicates the requested playback time to seek to
  • APSMediaPlayerInvalidLicenseNotification - Posted when the player license is invalid. Playback will be disabled.
  • APSMediaPlayerWillOpenMiniBrowser - Posted when the internal minibrowser will be opened.
  • APSMediaPlayerWillCloseMiniBrowser - Posted when the internal minibrowser will be dismissed.
  • APSMediaPlayerPlaybackDidFinishNotification - Posted when the internal player backend finished playback. The reason for playback finish in the form of a APSMovieFinishReason value can be retrieved from the userInfo dictionary attached to the notification, under the kAPSMediaPlayerPlaybackDidFinishReason key.
  • APSMediaPlayerLoadStateDidChangeNotification - Posted when the media load state changed. Value can be retrieved from player shared instance.
  • APSMediaPlayerDurationAvailableNotification - Posted when the duration of the played media becomes available. Value can be retrieved from player shared instance.
  • APSMediaPlayerPlaybackStateDidChangeNotification - Posted when the media playback state changed. Value can be retrieved from player shared instance.
  • APSMediaPlayerVolumeDidChangeNotification - Posted when the volume changed. Value can be retrieved from player shared instance.

Adapter groups

  • kAPSMediaPlayerOverlayControllersGroup - The group name that 3rd party overlay controllers must use when registering with the player. See APSMediaPlayerOverlayControllerProtocol for more details.
  • kAPSMediaPlayerUnitManagersGroup - The group name that 3rd party unit managers must use when registering with the player. See APSUnitManagerProtocol for more details.
  • kAPSMediaPlayerBackendsGroup - The group name that 3rd party backend renderers must use when registering with the player. See APSMediaPlayerProtocol for more details.
  • kAPSMediaPlayerControlPluginsGroup - The group name that 3rd party control plugins must use when registering with the player. See APSControlPluginProtocol for more details.

Accessing the APSMediaPlayer Instance and its View

  • Returns the shared APSMediaPlayer instance, creating it if necessary.

    Declaration

    Objective-C

    + (instancetype _Nonnull)sharedInstance;

    Swift

    class func sharedInstance() -> Self

    Return Value

    The shared APSMediaPlayer instance

  • List of supported media types

    Declaration

    Objective-C

    + (NSArray<NSString *> *_Nonnull)supportedMimeTypes;

    Swift

    class func supportedMimeTypes() -> [String]

    Return Value

    An array of supported media types by APSMediaPlayer

  • The container UIView of the player.

    Declaration

    Objective-C

    @property (nonatomic, readonly) UIView *_Nonnull view;

    Swift

    var view: UIView { get }

  • Call this method to set the player view frame.

    Declaration

    Objective-C

    - (void)setFrame:(CGRect)frame;

    Swift

    func setFrame(_ frame: CGRect)

    Parameters

    frame

    CGRect player view frame.

  • The backend player to use - call this if you are using constants instead of classes. Otherwise, use backendPlayerClass.

    Declaration

    Objective-C

    @property (nonatomic) APSBackendPlayer _Nonnull backendPlayer;

    Swift

    var backendPlayer: String { get set }

  • A class which is compliant to APSMediaPlayerProtocol and which will be used as a backend player. Use [APSAVPlayer class] for the AVPlayer-based backend or [APSMPMoviePlayer class] for the MPMoviePlayerController-based backend.

    Declaration

    Objective-C

    @property (nonatomic, strong) Class _Nonnull backendPlayerClass;

    Swift

    var backendPlayerClass: AnyClass { get set }

  • Enable debug logging

    Declaration

    Objective-C

    @property (nonatomic) BOOL debug;

    Swift

    var debug: Bool { get set }

  • The user agent that should be used when making HTTP requests.

    Declaration

    Objective-C

    @property (nonatomic) NSString *_Nullable userAgent;

    Swift

    var userAgent: String? { get set }

  • Consent information regarding GDPR and other regulations

    Declaration

    Objective-C

    @property (nonatomic) APSVASTRegulationInformation *_Nullable regulationInformation;

    Swift

    var regulationInformation: APSVASTRegulationInformation? { get set }

  • Set this to NO to disable internal fullscreen handling. Fullscreen functionality should be implemented externally, using the available methods and notifications emitted by the player.

    Declaration

    Objective-C

    @property (nonatomic) BOOL internalFullscreenSupport;

    Swift

    var internalFullscreenSupport: Bool { get set }

  • Set this to NO if you don’t want the player to automatically leave fullscreen state after stopping or playing all media units

    Declaration

    Objective-C

    @property (nonatomic) BOOL leaveFullscreenOnStop;

    Swift

    var leaveFullscreenOnStop: Bool { get set }

  • Enable auto-fullscreen on device orientation

    Declaration

    Objective-C

    @property (nonatomic) BOOL fullscreenOnLandscapeRotate;

    Swift

    var fullscreenOnLandscapeRotate: Bool { get set }

  • Pauses video when player loses viewability

    Declaration

    Objective-C

    @property (nonatomic) BOOL autoPauseWhenNotVisible;

    Swift

    var autoPauseWhenNotVisible: Bool { get set }

  • Enables advanced viewability tracking algorithms, which are more CPU expensive but more precise

    Declaration

    Objective-C

    @property (nonatomic) BOOL advancedViewabilityTracking;

    Swift

    var advancedViewabilityTracking: Bool { get set }

  • Enable Google’s IMA SDK

    Declaration

    Objective-C

    @property (nonatomic) BOOL preferGoogleIma;

    Swift

    var preferGoogleIma: Bool { get set }

  • Define allowed orientations for fullscreen mode

    Declaration

    Objective-C

    @property (nonatomic) APSFullscreenOrientationBehaviour fullscreenOrientationBehaviour;

    Swift

    var fullscreenOrientationBehaviour: APSFullscreenOrientationBehaviour { get set }

Working with Media Units

  • Prepare media units so they can be gapless played (when supported)

    Declaration

    Objective-C

    - (void)prepareMediaUnits:(NSArray *_Nonnull)mediaUnits;

    Swift

    func prepareMediaUnits(_ mediaUnits: [Any])

    Parameters

    mediaUnits

    An array of APSMediaUnit objects.

  • Sets and begins playback of an array of media units.

    Declaration

    Objective-C

    - (void)playMediaUnits:(NSArray *_Nonnull)mediaUnits;

    Swift

    func playMediaUnits(_ mediaUnits: [Any])

    Parameters

    mediaUnits

    An array of APSMediaUnit objects.

  • Inserts new media units after the current one, in the current playlist.

    Declaration

    Objective-C

    - (void)insertMediaUnits:(NSArray *_Nonnull)mediaUnits;

    Swift

    func insertMediaUnits(_ mediaUnits: [Any])

    Parameters

    mediaUnits

    An array of APSMediaUnit objects to be inserted into the playlist after the current unit.

  • Replaces the currently running media unit with multiple other units. Playback of the new units is started automatically.

    Declaration

    Objective-C

    - (void)replaceCurrentUnitWithUnits:(NSArray *_Nonnull)mediaUnits;

    Swift

    func replaceCurrentUnit(withUnits mediaUnits: [Any])

    Parameters

    mediaUnits

    An array of APSMediaUnit objects to be inserted into the playlist instead of the current unit.

  • Sets new units to the playlist, clearing any old ones.

    Declaration

    Objective-C

    - (void)setMediaUnits:(NSArray *_Nonnull)mediaUnits;

    Swift

    func setMediaUnits(_ mediaUnits: [Any])

    Parameters

    mediaUnits

    An array of APSMediaUnit objects to create a new playlist.

  • Returns the currently playing media unit.

    Declaration

    Objective-C

    - (APSMediaUnit *_Nullable)currentUnit;

    Swift

    func currentUnit() -> APSMediaUnit?

    Return Value

    An APSMediaUnit object representing the current unit.

  • Sets the video clip URL for the current media unit. The clip is processeed immmediately.

    Declaration

    Objective-C

    - (void)setCurrentURL:(NSURL *_Nonnull)url;

    Swift

    func setCurrentURL(_ url: URL)

    Parameters

    url

    The URL of the video clip.

  • Adds additional overlays to display over the current unit.

    Declaration

    Objective-C

    - (void)addOverlays:(NSArray *_Nonnull)overlays;

    Swift

    func addOverlays(_ overlays: [Any])

    Parameters

    overlays

    Additional APSMediaOverlay objects to inject.

  • Adds additional events to the current unit’s timeline.

    Declaration

    Objective-C

    - (void)addEvents:(NSArray *_Nonnull)events;

    Swift

    func addEvents(_ events: [Any])

    Parameters

    overlays

    Additional APSMediaEvent objects to inject.

Tracking Playback Events

  • This method triggers an APSMediaPlayerTrackedEventNotification notification.

    Warning

    Also sends tracking information to one or more servers. All specified URLs will be requested via GET. If the given object is an instance of the APSMediaUnit or the APSMediaOverlay classes, the trackingURLs dictionary property will be searched for the type key to identify the URLs that need to be pinged. Alternatively, you can pass a NSArray, a NSURL or a NSString as the object parameter. See “Available Tracking Events” for a list of supported event types.

    Declaration

    Objective-C

    - (void)trackEvent:(APSEvent *_Nonnull)event;

    Swift

    func trackEvent(_ event: APSEvent)

    Parameters

    event

    The APSEvent object containing event info.

  • Deprecated

    use trackEvent: instead

    This is a wrapper for trackEvent:type:forObject:metadata:urls:

    Declaration

    Objective-C

    - (void)trackEvent:(NSString *_Nonnull)event
              type:(NSString *_Nonnull)type
         forObject:(id _Nullable)object;

    Swift

    func trackEvent(_ event: String, type: String, for object: Any?)

    Parameters

    event

    The specific event subtype. May be nil for simple events.
    type

    The tracked event type. See “Available Tracking Events”.
    object

    The APSMediaUnit or APSMediaOverlay instance that generated the notification. Can be nil for non-unit related events.

URL Handling

  • The player’s action delegate. Any intent to execute specific URLs as a result of user interaction will be notified to the delegate for action.

    Declaration

    Objective-C

    @property (nonatomic, weak) id<APSMediaPlayerActionDelegate> _Nullable actionDelegate;

    Swift

    weak var actionDelegate: APSMediaPlayerActionDelegate? { get set }

  • The view controller that will be used to present any modal views by the player.

    Declaration

    Objective-C

    @property (nonatomic, weak) UIViewController *_Nullable modalViewControllerRoot;

    Swift

    weak var modalViewControllerRoot: UIViewController? { get set }

  • Instructs the player that a new URL needs to be interpreted and executed. This method will first ask the actionDelegate to respond to the given URL. If the actionDelegate declines to respond and the URL has a web scheme (`http://‘ or 'https://’) then an in-app web browser window will be displayed modally.

    Declaration

    Objective-C

    - (void)openURL:(NSURL *_Nonnull)url;

    Swift

    func open(_ url: URL)

    Parameters

    url

    The URL that needs to be loaded.

  • Instructs the player that a new URL needs to be interpreted and executed. This method also specifies the calling overlay controller, as it can define specific behavior for the player upon returning to the foreground after the playback interruption (see onWebviewDismiss in APSMediaPlayerOverlayController.h).

    Declaration

    Objective-C

    - (void)openURL:(NSURL *_Nonnull)url
           from:(APSMediaPlayerOverlayController *_Nullable)overlayController;

    Swift

    func open(_ url: URL, from overlayController: APSMediaPlayerOverlayController?)

    Parameters

    url

    The URL that needs to be loaded.
    overlayController

    The calling overlay controller.

Handling Playback

  • Returns a Boolean value specifing if the player is currently rendering a playlist of units (read-only).

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL isProcessing;

    Swift

    var isProcessing: Bool { get }

  • Starts playback of the current unit.

    Declaration

    Objective-C

    - (void)play;

    Swift

    func play()

  • Pauses playback of the current unit.

    Declaration

    Objective-C

    - (void)pause;

    Swift

    func pause()

  • Interrupts video playback - same as pause, but will not trigger the same events as human interaction would.

    Declaration

    Objective-C

    - (void)interrupt;

    Swift

    func interrupt()

  • Stops playback of the current unit.

    Declaration

    Objective-C

    - (void)stop;

    Swift

    func stop()

  • Proceeds to the next unit in the playlist and sends a skip event.

    Declaration

    Objective-C

    - (void)skip;

    Swift

    func skip()

  • Proceeds to the next unit in the playlist and sends an exit event.

    Declaration

    Objective-C

    - (void)next;

    Swift

    func next()

  • Proceeds to the next unit in the playlist.

    Declaration

    Objective-C

    - (void)step;

    Swift

    func step()

  • Replays the most recently played unit in the current playlist that has the canReplay property set to YES. If no such units are found, the current unit is restarted.

    Declaration

    Objective-C

    - (void)previous;

    Swift

    func previous()

  • A block object that will get executed when a playlist of units is finished rendering by the player.

    Declaration

    Objective-C

    @property (nonatomic, copy) APSMediaPlayerFinishBlock _Nullable onFinish;

    Swift

    var onFinish: APSMediaPlayerFinishBlock? { get set }

Getting Playback Information

  • Returns the current playback time.

    Declaration

    Objective-C

    - (NSTimeInterval)currentPlaybackTime;

    Swift

    func currentPlaybackTime() -> TimeInterval

    Return Value

    The current playback time.

  • Sets the current playback time.

    Declaration

    Objective-C

    - (void)setCurrentPlaybackTime:(NSTimeInterval)playbackTime;

    Swift

    func setCurrentPlaybackTime(_ playbackTime: TimeInterval)

    Parameters

    playbackTime

    The playback time to be set.

  • Returns the current unit’s video clip total duration.

    Declaration

    Objective-C

    - (NSTimeInterval)duration;

    Swift

    func duration() -> TimeInterval

    Return Value

    The video total duration.

  • Returns the current unit’s video clip playable duration (the time interval that has already buffered and is ready for playback).

    Declaration

    Objective-C

    - (NSTimeInterval)playableDuration;

    Swift

    func playableDuration() -> TimeInterval

    Return Value

    The video playable duration.

  • Returns the current unit’s playback state.

    Declaration

    Objective-C

    - (APSMoviePlaybackState)playbackState;

    Swift

    func playbackState() -> APSMoviePlaybackState

    Return Value

    The current playback state.

  • Returns the current unit’s load state.

    Declaration

    Objective-C

    - (APSMovieLoadState)loadState;

    Swift

    func loadState() -> APSMovieLoadState

    Return Value

    The current load state.

  • Returns the current unit’s movie source type.

    Declaration

    Objective-C

    - (APSMovieSourceType)movieSourceType;

    Swift

    func movieSourceType() -> APSMovieSourceType

    Return Value

    The movie source type.

  • Returns YES if the player is currently rendering a live stream.

    Declaration

    Objective-C

    - (BOOL)isStreamingLive;

    Swift

    func isStreamingLive() -> Bool

    Return Value

    YES if the player is currently rendering a live stream.

  • Obtains the most recent time-based metadata provided by the streamed movie.

    Declaration

    Objective-C

    - (NSArray *_Nullable)timedMetadata;

    Swift

    func timedMetadata() -> [Any]?

    Return Value

    An array of the most recent MPTimedMetadata objects provided by the streamed movie. See Apple’s documentation for_Nullable more details about MPTimedMetadata.

  • Set the sound volume of the player, in the range of 0.0 to 1.0.

    Declaration

    Objective-C

    - (void)setVolume:(CGFloat)volume;

    Swift

    func setVolume(_ volume: CGFloat)

    Parameters

    volume

    CGFloat sound volume.

  • Get the sound volume of the player, in the range of 0.0 to 1.0.

    Declaration

    Objective-C

    - (CGFloat)getVolume;

    Swift

    func getVolume() -> CGFloat

    Return Value

    The sound volume of the player

  • Mute the player

    Declaration

    Objective-C

    - (void)setMute:(BOOL)mute;

    Swift

    func setMute(_ mute: Bool)

    Parameters

    mute

    BOOL set YES to mute or NO to unmute.

  • Get if the player is muted or no

    Declaration

    Objective-C

    - (BOOL)getMute;

    Swift

    func getMute() -> Bool

    Return Value

    The mute status

  • Get the player’s viewability state

    Declaration

    Objective-C

    @property (nonatomic, readonly) APSViewability viewability;

    Swift

    var viewability: APSViewability { get }

    Return Value

    Player’s viewability state

  • Returns a NSDictionary with available subtitles The dictionary has the form {“language_code” : “Language Name”}

    Declaration

    Objective-C

    - (NSDictionary *_Nonnull)availableSubtitles;

    Swift

    func availableSubtitles() -> [AnyHashable : Any]

    Return Value

    A NSDictionary with available subtitles

  • Enable the corresponding subtitle for the given language

    Declaration

    Objective-C

    - (void)enableSubtitle:(NSString *_Nonnull)language;

    Swift

    func enableSubtitle(_ language: String)

    Parameters

    language

    NSString the language code to enable

  • Returns a NSDictionary with available audio tracks The dictionary has the form {“track_id” : “Track name”}

    Declaration

    Objective-C

    - (NSDictionary *_Nonnull)availableAudioTracks;

    Swift

    func availableAudioTracks() -> [AnyHashable : Any]

    Return Value

    A NSDictionary with available audio tracks

  • Select the corresponding audio track for the given audio track ID

    Declaration

    Objective-C

    - (void)enableAudioTrack:(NSString *_Nonnull)trackId;

    Swift

    func enableAudioTrack(_ trackId: String)

    Parameters

    trackId

    NSString the audio track ID to enable

Getting Video Thumbnails

  • Returns a snapshot image of the current video, at the requested time interval in the playback.

    Warning

    This method executes blocking operations on a background thread, and invokes the callback block on the main thread.

    Declaration

    Objective-C

    - (void)thumbnailAt:(NSTimeInterval)playbackTime
    withCompletionBlock:(APSThumbnailGeneratedBlock _Nonnull)block;

    Swift

    func thumbnail(at playbackTime: TimeInterval, withCompletionBlock block: @escaping APSThumbnailGeneratedBlock)

    Parameters

    playbackTime

    The time when the thumbnail should be taken from the video.
    block

    The block to be invoked on thumbnail generation completion.

Handling Fullscreen

  • Returns a Boolean value specifing if the player is currently in fullscreen (read-only).

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL isFullscreen;

    Swift

    var isFullscreen: Bool { get }

  • Toggle the current fullscreen status.

    Declaration

    Objective-C

    - (void)toggleFullscreen;

    Swift

    func toggleFullscreen()

  • Enter fullscreen mode.

    Declaration

    Objective-C

    - (void)enterFullscreen;

    Swift

    func enterFullscreen()

  • Exit fullscreen mode.

    Declaration

    Objective-C

    - (void)exitFullscreen;

    Swift

    func exitFullscreen()

Handling Picture in Picture

  • Returns a Boolean value specifing if Picture in Picture is currently active

    Declaration

    Objective-C

    - (BOOL)isPictureInPictureActive;

    Swift

    func isPictureInPictureActive() -> Bool

  • Toggle Picture in Picture mode

    Declaration

    Objective-C

    - (void)togglePictureInPicture;

    Swift

    func togglePictureInPicture()

  • Start Picture in Picture mode

    Declaration

    Objective-C

    - (void)startPictureInPicture;

    Swift

    func startPictureInPicture()

  • Stop Picture in Picture mode

    Declaration

    Objective-C

    - (void)stopPictureInPicture;

    Swift

    func stopPictureInPicture()

Extending

Airplay

  • Specifies whether the movie player allows AirPlay movie playback.

    Declaration

    Objective-C

    @property (nonatomic) BOOL allowsAirPlay;

    Swift

    var allowsAirPlay: Bool { get set }

  • Indicates whether the movie player is currently playing video via AirPlay.

    Declaration

    Objective-C

    - (BOOL)airPlayVideoActive;

    Swift

    func airPlayVideoActive() -> Bool

Other

  • Shows an activity indicator, centrally in the player surface.

    Declaration

    Objective-C

    - (void)showActivityIndicator;

    Swift

    func showActivityIndicator()

  • Hides the player activity indicator.

    Declaration

    Objective-C

    - (void)hideActivityIndicator;

    Swift

    func hideActivityIndicator()

  • Deprecated

    use resetDisplayedOverlays:animated instead.

    Resets all displayed overlays.

    Declaration

    Objective-C

    - (void)resetDisplayedOverlays;

    Swift

    func resetDisplayedOverlays()

  • Resets all displayed overlays.

    Declaration

    Objective-C

    - (void)resetDisplayedOverlays:(BOOL)animated;

    Swift

    func resetDisplayedOverlays(_ animated: Bool)

  • Returns an array of units owned by an APSVASTAdbreak object

    Declaration

    Objective-C

    - (NSArray *_Nonnull)unitsForAdbreak:(APSVASTAdBreak *_Nonnull)adbreak;

    Swift

    func units(forAdbreak adbreak: APSVASTAdBreak) -> [Any]

  • Parses a string format and returns a translated time interval in seconds.

    Declaration

    Objective-C

    + (NSTimeInterval)durationFromString:(NSString *_Nonnull)string;

    Swift

    class func duration(from string: String) -> TimeInterval

    Parameters

    string

    The string format to be translated. Must be in the format @“hh:mm:ss”.

    Return Value

    The translated time interval in seconds.

  • Specifies whether the player should ignore the device silent switch setting.

    Declaration

    Objective-C

    @property (nonatomic) BOOL ignoreSilentSwitch;

    Swift

    var ignoreSilentSwitch: Bool { get set }

  • Specifies whether the player should stop functioning if the currently running device is detected to be jailbroken.

    Declaration

    Objective-C

    @property (nonatomic) BOOL detectBreachedDevice;

    Swift

    var detectBreachedDevice: Bool { get set }

  • Set this to true to continue playing videos while the app is in background

    Declaration

    Objective-C

    @property (nonatomic) BOOL enableBackgroundPlayback;

    Swift

    var enableBackgroundPlayback: Bool { get set }

  • Deprecated

    Use APSVASTAdBreak delegate.

    Use this property to store the unique device advertising identifier, that can then be used by 3rd party components.

    Declaration

    Objective-C

    @property (nonatomic) __deprecated_msg("Use APSVASTAdBreak delegate.") NSString *advertisingIdentifier;

    Swift

    var advertisingIdentifier: String? { get set }

  • A NSURLSession used for retrieving data from the internet

    Declaration

    Objective-C

    @property (nonatomic, readonly, nonnull) NSURLSession *urlSession;

    Swift

    var urlSession: URLSession { get }

  • Resets the media player backend.

    Declaration

    Objective-C

    - (void)clear;

    Swift

    func clear()