From 98d5909f0d24349bdb203a34c9c0a5e5a44b72bb Mon Sep 17 00:00:00 2001 From: Ovidiu Nitan Date: Wed, 23 Dec 2015 15:21:07 +0200 Subject: [PATCH] Fix wrong behaviour when seeking back and using APSHandleSeekEventPlayLastBreak --- CHANGELOG.md | 3 +++ Docs/Blocks/APSMediaPlayerFinishBlock.html | 4 ++-- Docs/Categories/AVPlayer+View.html | 4 ++-- Docs/Classes/APSAVPlayer.html | 4 ++-- Docs/Classes/APSAVPlayerView.html | 4 ++-- Docs/Classes/APSChromeCastPlayer.html | 4 ++-- Docs/Classes/APSMPMoviePlayer.html | 4 ++-- Docs/Classes/APSMediaBuilder.html | 4 ++-- Docs/Classes/APSMediaEvent.html | 4 ++-- Docs/Classes/APSMediaOverlay.html | 4 ++-- Docs/Classes/APSMediaPlayer.html | 4 ++-- ...APSMediaPlayerButtonOverlayController.html | 4 ++-- ...SMediaPlayerClosableOverlayController.html | 4 ++-- ...SMediaPlayerControlsOverlayController.html | 4 ++-- .../APSMediaPlayerHTMLOverlayController.html | 4 ++-- .../APSMediaPlayerImageOverlayController.html | 4 ++-- .../APSMediaPlayerOverlayController.html | 4 ++-- .../APSMediaPlayerTextOverlayController.html | 4 ++-- .../APSMediaPlayerVimeoOverlayController.html | 4 ++-- ...PSMediaPlayerYoutubeOverlayController.html | 4 ++-- Docs/Classes/APSMediaUnit.html | 4 ++-- Docs/Classes/APSTimedMetadata.html | 4 ++-- Docs/Classes/APSVASTAdBreak.html | 4 ++-- Docs/Classes/APSVASTBannerConfiguration.html | 4 ++-- .../APSVASTCountdownConfiguration.html | 4 ++-- .../APSVASTFullscreenButtonConfiguration.html | 4 ++-- .../APSVASTFullscreenOverlayController.html | 4 ++-- Docs/Classes/APSVASTMediaBuilderPlugin.html | 4 ++-- .../APSVASTSkipButtonConfiguration.html | 4 ++-- .../Classes/APSVASTSkipOverlayController.html | 4 ++-- Docs/Classes/KRHub.html | 4 ++-- Docs/Constants/APSAVPlayerSeekStatus.html | 4 ++-- Docs/Constants/APSAdPodFallback.html | 4 ++-- Docs/Constants/APSBackendPlayer.html | 4 ++-- .../APSControlsOverlayComponents.html | 4 ++-- Docs/Constants/APSHandleSeekEvent.html | 4 ++-- Docs/Constants/APSMediaControlsDisplay.html | 4 ++-- Docs/Constants/APSMediaEventState.html | 4 ++-- Docs/Constants/APSMediaOverlayPosition.html | 4 ++-- Docs/Constants/APSMoviePlayerSourceType.html | 4 ++-- .../APSResolvMultipleAdsConflictsBy.html | 4 ++-- .../APSSkipOverlayProgressPosition.html | 4 ++-- Docs/Constants/APSVASTAdBreakType.html | 4 ++-- Docs/Constants/APSWebviewDismissedAction.html | 4 ++-- Docs/Protocols/APSMediaBuilderPlugin.html | 4 ++-- Docs/Protocols/APSMediaEventProtocol.html | 4 ++-- .../APSMediaPlayerActionDelegate.html | 4 ++-- ...SMediaPlayerOverlayControllerProtocol.html | 4 ++-- Docs/Protocols/APSMediaPlayerProtocol.html | 4 ++-- Docs/Protocols/APSMediaTrackableObject.html | 4 ++-- Docs/Protocols/APSUnitManagerProtocol.html | 4 ++-- Docs/Protocols/KRAdapter.html | 4 ++-- .../Contents/Info.plist | 4 ++-- .../Blocks/APSMediaPlayerFinishBlock.html | 4 ++-- .../Documents/Categories/AVPlayer+View.html | 4 ++-- .../Documents/Classes/APSAVPlayer.html | 4 ++-- .../Documents/Classes/APSAVPlayerView.html | 4 ++-- .../Classes/APSChromeCastPlayer.html | 4 ++-- .../Documents/Classes/APSMPMoviePlayer.html | 4 ++-- .../Documents/Classes/APSMediaBuilder.html | 4 ++-- .../Documents/Classes/APSMediaEvent.html | 4 ++-- .../Documents/Classes/APSMediaOverlay.html | 4 ++-- .../Documents/Classes/APSMediaPlayer.html | 4 ++-- ...APSMediaPlayerButtonOverlayController.html | 4 ++-- ...SMediaPlayerClosableOverlayController.html | 4 ++-- ...SMediaPlayerControlsOverlayController.html | 4 ++-- .../APSMediaPlayerHTMLOverlayController.html | 4 ++-- .../APSMediaPlayerImageOverlayController.html | 4 ++-- .../APSMediaPlayerOverlayController.html | 4 ++-- .../APSMediaPlayerTextOverlayController.html | 4 ++-- .../APSMediaPlayerVimeoOverlayController.html | 4 ++-- ...PSMediaPlayerYoutubeOverlayController.html | 4 ++-- .../Documents/Classes/APSMediaUnit.html | 4 ++-- .../Documents/Classes/APSTimedMetadata.html | 4 ++-- .../Documents/Classes/APSVASTAdBreak.html | 4 ++-- .../Classes/APSVASTBannerConfiguration.html | 4 ++-- .../APSVASTCountdownConfiguration.html | 4 ++-- .../APSVASTFullscreenButtonConfiguration.html | 4 ++-- .../APSVASTFullscreenOverlayController.html | 4 ++-- .../Classes/APSVASTMediaBuilderPlugin.html | 4 ++-- .../APSVASTSkipButtonConfiguration.html | 4 ++-- .../Classes/APSVASTSkipOverlayController.html | 4 ++-- .../Resources/Documents/Classes/KRHub.html | 4 ++-- .../Constants/APSAVPlayerSeekStatus.html | 4 ++-- .../Documents/Constants/APSAdPodFallback.html | 4 ++-- .../Documents/Constants/APSBackendPlayer.html | 4 ++-- .../APSControlsOverlayComponents.html | 4 ++-- .../Constants/APSHandleSeekEvent.html | 4 ++-- .../Constants/APSMediaControlsDisplay.html | 4 ++-- .../Constants/APSMediaEventState.html | 4 ++-- .../Constants/APSMediaOverlayPosition.html | 4 ++-- .../Constants/APSMoviePlayerSourceType.html | 4 ++-- .../APSResolvMultipleAdsConflictsBy.html | 4 ++-- .../APSSkipOverlayProgressPosition.html | 4 ++-- .../Constants/APSVASTAdBreakType.html | 4 ++-- .../Constants/APSWebviewDismissedAction.html | 4 ++-- .../Protocols/APSMediaBuilderPlugin.html | 4 ++-- .../Protocols/APSMediaEventProtocol.html | 4 ++-- .../APSMediaPlayerActionDelegate.html | 4 ++-- ...SMediaPlayerOverlayControllerProtocol.html | 4 ++-- .../Protocols/APSMediaPlayerProtocol.html | 4 ++-- .../Protocols/APSMediaTrackableObject.html | 4 ++-- .../Protocols/APSUnitManagerProtocol.html | 4 ++-- .../Documents/Protocols/KRAdapter.html | 4 ++-- .../Resources/Documents/hierarchy.html | 2 +- .../Contents/Resources/Documents/index.html | 4 ++-- .../Contents/Resources/docSet.dsidx | Bin 589824 -> 585728 bytes .../Contents/Resources/docSet.dsidx-shm | Bin 32768 -> 32768 bytes .../Contents/Resources/docSet.skidx | Bin 159744 -> 159744 bytes .../Contents/Resources/docSet.toc | Bin 8657 -> 8657 bytes .../Contents/Resources/docSet.tokencache | Bin 156961 -> 156982 bytes Docs/hierarchy.html | 2 +- Docs/index.html | 4 ++-- Docs/publish/VeesoPlayer.tgz | Bin 513918 -> 512663 bytes Docs/publish/VeesoPlayer.xml | 2 +- Docs/publish/docset.xar | Bin 787808 -> 787801 bytes Docs/publish/xcode-docset.atom | 14 +++++++------- .../APSMediaPlayerControlsOverlayController.h | 1 + VeesoPlayer.podspec | 2 +- libVeesoPlayer.a | Bin 5759768 -> 5762728 bytes 120 files changed, 225 insertions(+), 221 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ff826f37..88c955e6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,6 @@ +### 2.0.29 +Fix wrong behaviour when seeking back and using `APSHandleSeekEventPlayLastBreak` + ### 2.0.28 Improved Voiceover support diff --git a/Docs/Blocks/APSMediaPlayerFinishBlock.html b/Docs/Blocks/APSMediaPlayerFinishBlock.html index 6f92cfc8..27215431 100644 --- a/Docs/Blocks/APSMediaPlayerFinishBlock.html +++ b/Docs/Blocks/APSMediaPlayerFinishBlock.html @@ -5,7 +5,7 @@ if (navigator.userAgent.match(/xcode/i)){ document.documentElement.className += ' xcode' } - CocoaDocs.org - APSMediaPlayerFinishBlock Block Reference

VeesoPlayer2.0.28

Declared in APSMediaPlayer.h
Availability v1.7
CocoaDocs.org - AVPlayer(View) Category Reference

VeesoPlayer2.0.28

Declared in AVPlayer+View.h

Tasks

Properties

view

@property (nonatomic, weak) APSAVPlayerView *view
CocoaDocs.org - APSAVPlayer Class Reference

VeesoPlayer2.0.28

Inherits from NSObject
Conforms to APSMediaPlayerProtocol
KRAdapter
MPMediaPlayback
Declared in APSAVPlayer.h

Tasks

Accessing the APSAVPlayer's view

  •   view

    The container UIView of the player.

         property

Properties

Instance methods

Properties

airPlayVideoActive

@property (nonatomic, readonly) BOOL airPlayVideoActive
Discussion

Check out if AirPlay video is started or stopped.

Declared In

APSAVPlayer.h

allowsAirPlay

@property (nonatomic) BOOL allowsAirPlay
Discussion

Specifies whether the movie player allows AirPlay movie playback.

Declared In

APSAVPlayer.h

contentURL

@property (nonatomic, strong) NSURL *contentURL
Discussion

Get or set the current media’s URL

Declared In

APSAVPlayer.h

controlStyle

@property (nonatomic) MPMovieControlStyle controlStyle
Discussion

Set how the player controls will appear

Declared In

APSAVPlayer.h

currentPlaybackRate

@property (nonatomic) float currentPlaybackRate
Discussion

Get or set the current playback rate

Declared In

APSAVPlayer.h

currentPlaybackTime

@property (nonatomic) NSTimeInterval currentPlaybackTime
Discussion

Get or set the current position in stream

Declared In

APSAVPlayer.h

duration

@property (nonatomic, readonly) NSTimeInterval duration
Discussion

Get the total duration of the video

Declared In

APSAVPlayer.h

initialPlaybackTime

@property (nonatomic) NSTimeInterval initialPlaybackTime
Discussion

Get or set the initial time in stream from which the player will start playing the media

Declared In

APSAVPlayer.h

isPreparedToPlay

@property (nonatomic, readonly) BOOL isPreparedToPlay
Discussion

Returns a Boolean value specifing if the player is ready to play media

Declared In

APSAVPlayer.h

loadState

@property (nonatomic, readonly) MPMovieLoadState loadState
Discussion

Get the current state of the buffer

Declared In

APSAVPlayer.h

movieSourceType

@property (nonatomic) MPMovieSourceType movieSourceType
Discussion

Get the current media’s source type (e.g. file or stream)

Declared In

APSAVPlayer.h

playableDuration

@property (nonatomic, readonly) NSTimeInterval playableDuration
Discussion

Get the duration of the buffered content

Declared In

APSAVPlayer.h

playbackState

@property (nonatomic, readonly) MPMoviePlaybackState playbackState
Discussion

Get the current playback state

Declared In

APSAVPlayer.h

scalingMode

@property (nonatomic) MPMovieScalingMode scalingMode
Discussion

Get or set the scaling mode of the video according to its viewport

Declared In

APSAVPlayer.h

shouldAutoplay

@property (nonatomic) BOOL shouldAutoplay
Discussion

Get or set if the player should autoplay an URL as soon as it is provided

Declared In

APSAVPlayer.h

timedMetadata

@property (nonatomic, readonly) NSArray *timedMetadata
Discussion

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

Returns an array of the most recent MPTimedMetadata objects provided by the media stream.

Declared In

APSAVPlayer.h

view

@property (nonatomic, strong) UIView *view
Discussion

The container UIView of the player.

Declared In

APSAVPlayer.h

Class Methods

backendPriority

+ (NSInteger)backendPriority
Discussion

The priority based on which the backend will be selected

Declared In

APSAVPlayer.h

Instance Methods

appendURL:

- (void)appendURL:(NSURL *)url
Discussion

Add an URL to the current play queue

Parameters

url

A NSURL instance pointing to the media location

Declared In

APSAVPlayer.h

beginSeekingBackward

- (void)beginSeekingBackward
Discussion

Rewind the media

Declared In

APSAVPlayer.h

beginSeekingForward

- (void)beginSeekingForward
Discussion

Play the media with an increased playback rate (speed)

Declared In

APSAVPlayer.h

endSeeking

- (void)endSeeking
Discussion

Stop the seeking process startd by beginSeekingForward or beginSeekingBackward;

Declared In

APSAVPlayer.h

getMute

- (BOOL)getMute
Discussion

Get if the player is muted or no

Return Value

The mute status

Declared In

APSAVPlayer.h

getVolume

- (CGFloat)getVolume
Discussion

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

Return Value

The sound volume of the player

Declared In

APSAVPlayer.h

initWithURLs:

- (id)initWithURLs:(NSArray *)urls
Discussion

Create a APSAVPlayer instance

Parameters

urls

A NSArray of NSURLs pointing to the media location

Return Value

The APSAVPlayer instance

Declared In

APSAVPlayer.h

pause

- (void)pause
Discussion

Pause the current playing media

Declared In

APSAVPlayer.h

play

- (void)play
Discussion

Play the current media in the queue

Declared In

APSAVPlayer.h

prepareToPlay

- (void)prepareToPlay
Discussion

Prepare to play media. This is also automatically called on play

Declared In

APSAVPlayer.h

requestThumbnailImagesAtTimes:timeOption:

- (void)requestThumbnailImagesAtTimes:(NSArray *)playbackTimes timeOption:(MPMovieTimeOption)option
Discussion

Request a thumbnail image

Parameters

playbackTimes

A NSArray of NSTimeInterval, in seconds, when the thumbnail should be taken from the video

option

Precision

Return Value

The thumbnail image

Declared In

APSAVPlayer.h

setMute:

- (void)setMute:(BOOL)mute
Discussion

Mute the player

Parameters

mute

BOOL set YES to mute or NO to unmute.

Declared In

APSAVPlayer.h

setVolume:

- (void)setVolume:(CGFloat)volume
Discussion

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

Parameters

volume

CGFloat sound volume.

Declared In

APSAVPlayer.h

stop

- (void)stop
Discussion

Stop the player, remove all the items from the queue and remove the player’s CALayer from its superlayer

Declared In

APSAVPlayer.h

streamSourceType

- (APSMoviePlayerSourceType)streamSourceType
Discussion

Get the stream’s source type. Different by movieSourceType because it returns if the stream is a VOD stream or a live stream.

Return Value

The stream’s type as a APSMoviePlayerSourceType enum

Declared In

APSAVPlayer.h

thumbnailAt:

- (UIImage *)thumbnailAt:(NSTimeInterval)playbackTime
Discussion

Request a thumbnail image

Parameters

playbackTime

The time, in seconds, when the thumbnail should be taken from the video

Return Value

The thumbnail image

Declared In

APSAVPlayer.h

thumbnailImageAtTime:timeOption:

- (UIImage *)thumbnailImageAtTime:(NSTimeInterval)playbackTime timeOption:(MPMovieTimeOption)option
Discussion

Request a thumbnail image

Parameters

playbackTime

The time, in seconds, when the thumbnail should be taken from the video

option

Precision

Return Value

The thumbnail image

Declared In

APSAVPlayer.h

CocoaDocs.org - APSAVPlayerView Class Reference

VeesoPlayer2.0.28

Inherits from UIView
Declared in APSAVPlayerView.h

Tasks

Setting and getting AVPlayer instance

  • – player

    Get the AVPlayer instance associated with the current view.
  • – setPlayer:

    Set an AVPlayer instance to the current view.

Instance Methods

player

- (AVPlayer *)player
Discussion

Get the AVPlayer instance associated with the current view.

Declared In

APSAVPlayerView.h

setPlayer:

- (void)setPlayer:(AVPlayer *)player
Discussion

Set an AVPlayer instance to the current view.

Parameters

player

An AVPlayer instance

Declared In

APSAVPlayerView.h

CocoaDocs.org - APSChromeCastPlayer Class Reference

VeesoPlayer2.0.28

Inherits from NSObject
Conforms to APSMediaPlayerProtocol
GCKMediaControlChannelDelegate
KRAdapter
Declared in APSChromeCastPlayer.h

Tasks

Accessing the APSAVPlayer's view

  •   view

    The container UIView of the player.

         property

Properties

Instance methods

Properties

airPlayVideoActive

@property (nonatomic, readonly) BOOL airPlayVideoActive
Discussion

Check out if AirPlay video is started or stopped.

Declared In

APSChromeCastPlayer.h

allowsAirPlay

@property (nonatomic) BOOL allowsAirPlay
Discussion

Specifies whether the movie player allows AirPlay movie playback.

Declared In

APSChromeCastPlayer.h

contentURL

@property (nonatomic, strong) NSURL *contentURL
Discussion

Get or set the current media’s URL

Declared In

APSChromeCastPlayer.h

controlStyle

@property (nonatomic) MPMovieControlStyle controlStyle
Discussion

Set how the player controls will appear

Declared In

APSChromeCastPlayer.h

currentPlaybackRate

@property (nonatomic) float currentPlaybackRate
Discussion

Get or set the current playback rate

Declared In

APSChromeCastPlayer.h

currentPlaybackTime

@property (nonatomic) NSTimeInterval currentPlaybackTime
Discussion

Get or set the current position in stream

Declared In

APSChromeCastPlayer.h

duration

@property (nonatomic, readonly) NSTimeInterval duration
Discussion

Get the total duration of the video

Declared In

APSChromeCastPlayer.h

initialPlaybackTime

@property (nonatomic) NSTimeInterval initialPlaybackTime
Discussion

Get or set the initial time in stream from which the player will start playing the media

Declared In

APSChromeCastPlayer.h

isPreparedToPlay

@property (nonatomic, readonly) BOOL isPreparedToPlay
Discussion

Returns a Boolean value specifing if the player is ready to play media

Declared In

APSChromeCastPlayer.h

loadState

@property (nonatomic, readonly) MPMovieLoadState loadState
Discussion

Get the current state of the buffer

Declared In

APSChromeCastPlayer.h

movieSourceType

@property (nonatomic) MPMovieSourceType movieSourceType
Discussion

Get the current media’s source type (e.g. file or stream)

Declared In

APSChromeCastPlayer.h

playableDuration

@property (nonatomic, readonly) NSTimeInterval playableDuration
Discussion

Get the duration of the buffered content

Declared In

APSChromeCastPlayer.h

playbackState

@property (nonatomic, readonly) MPMoviePlaybackState playbackState
Discussion

Get the current playback state

Declared In

APSChromeCastPlayer.h

scalingMode

@property (nonatomic) MPMovieScalingMode scalingMode
Discussion

Get or set the scaling mode of the video according to its viewport

Declared In

APSChromeCastPlayer.h

shouldAutoplay

@property (nonatomic) BOOL shouldAutoplay
Discussion

Get or set if the player should autoplay an URL as soon as it is provided

Declared In

APSChromeCastPlayer.h

timedMetadata

@property (nonatomic, readonly) NSArray *timedMetadata
Discussion

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

Returns an array of the most recent MPTimedMetadata objects provided by the media stream.

Declared In

APSChromeCastPlayer.h

view

@property (nonatomic, strong) UIView *view
Discussion

The container UIView of the player.

Declared In

APSChromeCastPlayer.h

Class Methods

backendPriority

+ (NSInteger)backendPriority
Discussion

The priority based on which the backend will be selected

Declared In

APSChromeCastPlayer.h

Instance Methods

beginSeekingBackward

- (void)beginSeekingBackward
Discussion

Rewind the media

Declared In

APSChromeCastPlayer.h

beginSeekingForward

- (void)beginSeekingForward
Discussion

Play the media with an increased playback rate (speed)

Declared In

APSChromeCastPlayer.h

endSeeking

- (void)endSeeking
Discussion

Stop the seeking process startd by beginSeekingForward or beginSeekingBackward;

Declared In

APSChromeCastPlayer.h

getMute

- (BOOL)getMute
Discussion

Get if the player is muted or no

Return Value

The mute status

Declared In

APSChromeCastPlayer.h

getVolume

- (CGFloat)getVolume
Discussion

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

Return Value

The sound volume of the player

Declared In

APSChromeCastPlayer.h

initWithURLs:

- (id)initWithURLs:(NSArray *)urls
Discussion

Create a APSAVPlayer instance

Parameters

urls

A NSArray of NSURLs pointing to the media location

Return Value

The APSAVPlayer instance

Declared In

APSChromeCastPlayer.h

pause

- (void)pause
Discussion

Pause the current playing media

Declared In

APSChromeCastPlayer.h

play

- (void)play
Discussion

Play the current media in the queue

Declared In

APSChromeCastPlayer.h

prepareToPlay

- (void)prepareToPlay
Discussion

Add an URL to the current play queue

Parameters

url

A NSURL instance pointing to the media location

Declared In

APSChromeCastPlayer.h

requestThumbnailImagesAtTimes:timeOption:

- (void)requestThumbnailImagesAtTimes:(NSArray *)playbackTimes timeOption:(MPMovieTimeOption)option
Discussion

Request a thumbnail image

Parameters

playbackTimes

A NSArray of NSTimeInterval, in seconds, when the thumbnail should be taken from the video

option

Precision

Return Value

The thumbnail image

Declared In

APSChromeCastPlayer.h

setMute:

- (void)setMute:(BOOL)mute
Discussion

Mute the player

Parameters

mute

BOOL set YES to mute or NO to unmute.

Declared In

APSChromeCastPlayer.h

setVolume:

- (void)setVolume:(CGFloat)volume
Discussion

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

Parameters

volume

CGFloat sound volume.

Declared In

APSChromeCastPlayer.h

stop

- (void)stop
Discussion

Stop the player, remove all the items from the queue and remove the player’s CALayer from its superlayer

Declared In

APSChromeCastPlayer.h

streamSourceType

- (APSMoviePlayerSourceType)streamSourceType
Discussion

Get the stream’s source type. Different by movieSourceType because it returns if the stream is a VOD stream or a live stream.

Return Value

The stream’s type as a APSMoviePlayerSourceType enum

Declared In

APSChromeCastPlayer.h

thumbnailAt:

- (UIImage *)thumbnailAt:(NSTimeInterval)playbackTime
Discussion

Request a thumbnail image

Parameters

playbackTime

The time, in seconds, when the thumbnail should be taken from the video

Return Value

The thumbnail image

Declared In

APSChromeCastPlayer.h

thumbnailImageAtTime:timeOption:

- (UIImage *)thumbnailImageAtTime:(NSTimeInterval)playbackTime timeOption:(MPMovieTimeOption)option
Discussion

Request a thumbnail image

Parameters

playbackTime

The time, in seconds, when the thumbnail should be taken from the video

option

Precision

Return Value

The thumbnail image

Declared In

APSChromeCastPlayer.h

CocoaDocs.org - APSMPMoviePlayer Class Reference

VeesoPlayer2.0.28

Inherits from MPMoviePlayerController
Conforms to APSMediaPlayerProtocol
KRAdapter
Declared in APSMPMoviePlayer.h

Tasks

Class Methods

backendPriority

+ (NSInteger)backendPriority
Discussion

The priority based on which the backend will be selected

Declared In

APSMPMoviePlayer.h

Instance Methods

getMute

- (BOOL)getMute
Discussion

Get if the player is muted or no

Return Value

The mute status

Declared In

APSMPMoviePlayer.h

getVolume

- (CGFloat)getVolume
Discussion

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

Return Value

The sound volume of the player

Declared In

APSMPMoviePlayer.h

setMute:

- (void)setMute:(BOOL)mute
Discussion

Mute the player

Parameters

mute

BOOL set YES to mute or NO to unmute.

Declared In

APSMPMoviePlayer.h

setVolume:

- (void)setVolume:(CGFloat)volume
Discussion

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

Parameters

volume

CGFloat sound volume.

Declared In

APSMPMoviePlayer.h

CocoaDocs.org - APSMediaBuilder Class Reference

VeesoPlayer2.0.28

Inherits from KRHub : NSObject
Declared in APSMediaBuilder.h

Overview

The APSMediaBuilder assists in creating playlists of fully configurable APSMediaUnits, together with attached, configurable APSMediaOverlays, using JSON files or using a NSDictionary, both following the same structure.

The media builder also has class methods that assist with the generation of individual APSMediaUnit and APSMediaOverlay objects from corresponding JSON or NSDictionary structures.

Plugins can be attached to a media builder. Each plugin can dynamically insert, edit or remove units and/or overlays from the generated playlist.

Tasks

Unit and Overlay Factory Methods

Media Builder Initialization

Media Builder Configuration

Properties

  •   userAgent

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

         property
  •   debugMode

    This property enables or disables console logging on all generated units.

         property

Generating the Final Playlist

Adding Plugins

Properties

bumperUnits

@property (nonatomic) NSArray *bumperUnits
Discussion

Array containing APSMediaUnits that will be scheduled before ones in contentUnits in the generated playlist.

Declared In

APSMediaBuilder.h

contentUnits

@property (nonatomic) NSArray *contentUnits
Discussion

Array containing the main content APSMediaUnits that will make up the playlist.

In the finally rendered playlist, units from bumperUnits will be prefixed to the main content units, while units from exitUnits will be inserted after the main content units. Every array’s content may be modified by attached builder plugins.

Declared In

APSMediaBuilder.h

debugMode

@property (nonatomic) BOOL debugMode
Discussion

This property enables or disables console logging on all generated units.

Declared In

APSMediaBuilder.h

exitUnits

@property (nonatomic) NSArray *exitUnits
Discussion

Array containing APSMediaUnits that will be scheduled after ones in contentUnits in the generated playlist.

Declared In

APSMediaBuilder.h

userAgent

@property (nonatomic) NSString *userAgent
Discussion

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

Declared In

APSMediaBuilder.h

Class Methods

overlayFromDictionary:

+ (APSMediaOverlay *)overlayFromDictionary:(NSDictionary *)overlayConfigurations
Discussion

Factory method to generate new instance of APSMediaOverlay via NSDictionary configuration.

Parameters

overlayConfigurations

Dictionary overlay configuration.

Return Value

An instance of APSMediaOverlay or nil if error.

Declared In

APSMediaBuilder.h

unitFromDictionary:

+ (APSMediaUnit *)unitFromDictionary:(NSDictionary *)unitConfigurations
Discussion

Factory method to generate new instance of APSMediaUnit via NSDictionary configuration.

Parameters

unitConfigurations

Dictionary unit configuration.

Return Value

An instance of APSMediaUnit or nil if error.

Declared In

APSMediaBuilder.h

Instance Methods

addPlugin:

- (void)addPlugin:(NSObject<APSMediaBuilderPlugin> *)plugin
Discussion

Registers a new plugin.

Parameters

plugin

The new plugin object. Must implement APSMediaBuilderPlugin.

Declared In

APSMediaBuilder.h

configureFromData:

- (BOOL)configureFromData:(NSData *)data
Discussion

Configures the builder from a NSData object.

Warning: UTF8 encoding is assumed.

Parameters

data

Configuration data - UTF8 encoded.

Return Value

YES on succes.

Declared In

APSMediaBuilder.h

configureFromDictionary:

- (BOOL)configureFromDictionary:(NSDictionary *)configuration
Discussion

Configures the builder from a NSDictionary object.

Parameters

configuration

The configuration dictionary.

Return Value

YES on succes.

Declared In

APSMediaBuilder.h

configureFromURL:

- (BOOL)configureFromURL:(NSURL *)url
Discussion

Configures the builder from a JSON structure.

Warning: This method may execute blocking network I/O on the calling thread.

Parameters

url

The URL of the JSON structure to load. This can be a remote file or a local file.

Return Value

YES on succes.

Declared In

APSMediaBuilder.h

configureFromURL:onComplete:

- (void)configureFromURL:(NSURL *)url onComplete:(void ( ^ ) ( ))block
Discussion

Configures the builder asynchronously from a JSON structure.

Parameters

url

The URL of the JSON structure to load. This can be a remote file or a local file.

block

The block to be executed after configuration is finished.

Declared In

APSMediaBuilder.h

initWithMediaUnit:

- (instancetype)initWithMediaUnit:(APSMediaUnit *)contentUnit
Discussion

Initializes builder with a playlist of a single media unit.

Parameters

contentUnit

APSMediaUnit object to be played.

Return Value

APSMediaBuilder object.

Declared In

APSMediaBuilder.h

initWithMediaUnits:

- (instancetype)initWithMediaUnits:(NSArray *)contentUnits
Discussion

Initializes builder with a playlist of media units.

Parameters

contentUnits

Array of APSMediaUnit objects to be played.

Return Value

APSMediaBuilder object.

Declared In

APSMediaBuilder.h

mediaUnits

- (NSArray *)mediaUnits
Discussion

Returns a generated playlist of APSMediaUnits, based on builder configuration and registered plugins.

Warning: This method may execute blocking network I/O on the calling thread.

Return Value

An array of APSMediaUnits.

Declared In

APSMediaBuilder.h

requestMediaUnitsWithCompletionBlock:

- (void)requestMediaUnitsWithCompletionBlock:(void ( ^ ) ( NSArray *))block
Discussion

Asynchronously generates a playlist of APSMediaUnits, based on builder configuration and registered plugins.

Parameters

block

The block to be executed when playlist is generated.

Declared In

APSMediaBuilder.h

CocoaDocs.org - APSMediaEvent Class Reference

VeesoPlayer2.0.28

Inherits from NSObject
Conforms to APSMediaEventProtocol
Declared in APSMediaEvent.h

Overview

The APSMediaEvent class describes a container that developers can use to instruct the player to run specific blocks of code at specific moments of time. Objects extending this class and implementing the corresponding APSMediaEventProtocol protocol can be added to the player’s main queue and can also be attached to a specific APSMediaUnit object, for runtime triggering.

Tasks

Configuring the Event Interval

  • – setStartPoint:

    Sets the starting time point of the event.
  • – setEndPoint:

    Sets the ending time point of the event.
  • – startPoint

    The time interval (in seconds) when the player needs to trigger the event.
  • – endPoint

    The playback time (in seconds) when the player needs to unload the event. Defaults to -1 for events that should unload right after triggering.
  •   repeatAfter

    If this parameter is greater than 0, then the event will be retriggered by the media player after the specific time interval (in seconds).

         property
  • – incrementStartAndEndPointsWithInterval:

    Shifts air-time for an event by a defined amount of time.
  • – adjustRelativeToDuration:

    Translates percentual values set via setStartPoint and setEndPoint to actual time intervals in seconds, relative to a specified total duration.

Asynchroneous Pre-Trigger

Asynchroneous Event Preloading

  •   preloadInterval

    Defines the number of seconds before the scheduled start point when the event should receive the [APSMediaEventProtocol preload] message (if the method is implemented).

         property
  •   timeout

    Defines the maximum number of seconds the event is allowed to live once it has been pretriggered, without setting the loaded property to YES.

         property
  •   state

    The current lifecycle state of the event.

         property
  •   preloadPoint

    Set by the player to the current playback time in seconds, after the current event begins preloading. Defaults to -1 if the event did not start preloading.

         property
  •   dynamicPosition property

Properties

dynamicPosition

@property BOOL dynamicPosition

preloadInterval

@property (nonatomic) NSTimeInterval preloadInterval
Discussion

Defines the number of seconds before the scheduled start point when the event should receive the [APSMediaEventProtocol preload] message (if the method is implemented).

Declared In

APSMediaEvent.h

preloadPoint

@property NSTimeInterval preloadPoint
Discussion

Set by the player to the current playback time in seconds, after the current event begins preloading. Defaults to -1 if the event did not start preloading.

Declared In

APSMediaEvent.h

repeatAfter

@property (nonatomic) NSTimeInterval repeatAfter
Discussion

If this parameter is greater than 0, then the event will be retriggered by the media player after the specific time interval (in seconds).

Declared In

APSMediaEvent.h

state

@property APSMediaEventState state
Discussion

The current lifecycle state of the event.

Declared In

APSMediaEvent.h

timeout

@property (nonatomic) NSTimeInterval timeout
Discussion

Defines the maximum number of seconds the event is allowed to live once it has been pretriggered, without setting the loaded property to YES.

Declared In

APSMediaEvent.h

Instance Methods

adjustRelativeToDuration:

- (void)adjustRelativeToDuration:(NSTimeInterval)duration
Discussion

Translates percentual values set via setStartPoint and setEndPoint to actual time intervals in seconds, relative to a specified total duration.

Parameters

duration

The total duration.

Declared In

APSMediaEvent.h

endPoint

- (NSTimeInterval)endPoint
Discussion

The playback time (in seconds) when the player needs to unload the event. Defaults to -1 for events that should unload right after triggering.

Warning: If percentual values were set via setStartPoint, this value will change immediately after the current clip’s duration is available.

Return Value

The final time interval.

Declared In

APSMediaEvent.h

incrementStartAndEndPointsWithInterval:

- (void)incrementStartAndEndPointsWithInterval:(NSTimeInterval)duration
Discussion

Shifts air-time for an event by a defined amount of time.

Parameters

duration

Shift duration in seconds.

Declared In

APSMediaEvent.h

preload

- (void)preload
Discussion

Call this to preload the event.

Declared In

APSMediaEvent.h

setEndPoint:

- (void)setEndPoint:(NSString *)endPoint
Discussion

Sets the ending time point of the event.

Parameters

endPoint

A string format describing the time point when the player needs to unload the event. Possible values are seconds (e.g.: @“60”) or a percentage relative to the total duration of the parent clip (e.g.: @“50%”).

Declared In

APSMediaEvent.h

setStartPoint:

- (void)setStartPoint:(NSString *)startPoint
Discussion

Sets the starting time point of the event.

Parameters

startPoint

A string format describing the time point when the player needs to trigger the event. Possible values are seconds (e.g.: @“60”) or a percentage relative to the total duration of the parent clip (e.g.: @“50%”).

Declared In

APSMediaEvent.h

startPoint

- (NSTimeInterval)startPoint
Discussion

The time interval (in seconds) when the player needs to trigger the event.

Warning: If percentual values were set via setStartPoint, this value will change immediately after the current clip’s duration is available.

Return Value

The initial time interval.

Declared In

APSMediaEvent.h

trigger

- (void)trigger
Discussion

Call this to trigger the event.

Declared In

APSMediaEvent.h

CocoaDocs.org - APSMediaOverlay Class Reference

VeesoPlayer2.0.28

Inherits from APSMediaEvent : NSObject
Conforms to APSMediaTrackableObject
NSCopying
Declared in APSMediaOverlay.h

Overview

APSMediaOverlay describes any overlay that the APSMediaPlayer instance needs to render during playback.

Tasks

Setting the Overlay Type and Parameters

  •   type

    Overlay type. The values that can be used with this property are usually constants defined by each individual overlay controller

         property
  •   parameters

    Overlay parameters. Implementation-specific to overlay controllers.

         property

Positioning the Overlay On-Screen

  •   position

    Describes the position the overlay should take when placed on-screen by the player. See APSMediaOverlayPosition for available values.

         property
  •   zIndex

    The order of the overlay in the current view stack.

         property
  •   width

    The width of the overlay. Supports pixels (e.g.: @“320”) or percentages, relative to the total width (e.g.: @“50%”).

         property
  •   height

    The height of the overlay. Supports pixels (e.g.: @“320”) or percentages, relative to the total height (e.g.: @“50%”).

         property
  •   absoluteOffsetX

    The overlay’s absolute horizontal offset, relative to the current origin. The current origin is determined by the overlay’s position parameter, while the positive direction is always toward the center of the player surface. Supports pixels (e.g.: @“320”) or percentages, relative to the total width (e.g.: @“50%”).

         property
  •   absoluteOffsetY

    The overlay’s absolute vertical offset, relative to the current origin. The current origin is determined by the overlay’s position parameter, while the positive direction is always toward the center of the player surface. Supports pixels (e.g.: @“320”) or percentages, relative to the total height (e.g.: @“50%”).

         property

Overlay Properties

  •   fadeInDuration

    The duration (in seconds) for the fade in effect of the overlay, when it is placed on and taken off screen.

         property
  •   removeWhenHidden

    Defines if the overlay should be removed from memory when its' opacity becomes zero.

         property
  •   parentUnit

    After being added to a APSMediaUnit object, a reference to this parent can be found here.

         property
  •   controller

    A refence to the overlay controller object. This is set by the player, on the overlay’s initial render.

         property
  •   metadata

    Additional overlay information.

         property

Other

Properties

absoluteOffsetX

@property (nonatomic) NSString *absoluteOffsetX
Discussion

The overlay’s absolute horizontal offset, relative to the current origin. The current origin is determined by the overlay’s position parameter, while the positive direction is always toward the center of the player surface. Supports pixels (e.g.: @“320”) or percentages, relative to the total width (e.g.: @“50%”).

Declared In

APSMediaOverlay.h

absoluteOffsetY

@property (nonatomic) NSString *absoluteOffsetY
Discussion

The overlay’s absolute vertical offset, relative to the current origin. The current origin is determined by the overlay’s position parameter, while the positive direction is always toward the center of the player surface. Supports pixels (e.g.: @“320”) or percentages, relative to the total height (e.g.: @“50%”).

Declared In

APSMediaOverlay.h

controller

@property (nonatomic) APSMediaPlayerOverlayController *controller
Discussion

A refence to the overlay controller object. This is set by the player, on the overlay’s initial render.

Declared In

APSMediaOverlay.h

fadeInDuration

@property (nonatomic) CGFloat fadeInDuration
Discussion

The duration (in seconds) for the fade in effect of the overlay, when it is placed on and taken off screen.

Declared In

APSMediaOverlay.h

height

@property (nonatomic) NSString *height
Discussion

The height of the overlay. Supports pixels (e.g.: @“320”) or percentages, relative to the total height (e.g.: @“50%”).

Declared In

APSMediaOverlay.h

metadata

@property (nonatomic) NSMutableDictionary *metadata
Discussion

Additional overlay information.

Declared In

APSMediaOverlay.h

parameters

@property (nonatomic) NSMutableDictionary *parameters
Discussion

Overlay parameters. Implementation-specific to overlay controllers.

Declared In

APSMediaOverlay.h

parentUnit

@property (nonatomic, weak) APSMediaUnit *parentUnit
Discussion

After being added to a APSMediaUnit object, a reference to this parent can be found here.

Declared In

APSMediaOverlay.h

position

@property (nonatomic) APSMediaOverlayPosition position
Discussion

Describes the position the overlay should take when placed on-screen by the player. See APSMediaOverlayPosition for available values.

Declared In

APSMediaOverlay.h

removeWhenHidden

@property (nonatomic) BOOL removeWhenHidden
Discussion

Defines if the overlay should be removed from memory when its' opacity becomes zero.

Declared In

APSMediaOverlay.h

type

@property (nonatomic) NSString *type
Discussion

Overlay type. The values that can be used with this property are usually constants defined by each individual overlay controller

Declared In

APSMediaOverlay.h

width

@property (nonatomic) NSString *width
Discussion

The width of the overlay. Supports pixels (e.g.: @“320”) or percentages, relative to the total width (e.g.: @“50%”).

Declared In

APSMediaOverlay.h

zIndex

@property (nonatomic) int zIndex
Discussion

The order of the overlay in the current view stack.

Declared In

APSMediaOverlay.h

Class Methods

positionFromString:

+ (APSMediaOverlayPosition)positionFromString:(NSString *)position
Discussion

Converts a string format to a APSMediaOverlayPosition value.

Parameters

position

The position of the overlay. Possible values are: - “top” - “topLeft” - “topRight” - “bottomLeft” - “bottomRight” - “bottom” - “fullscreen”

Return Value

The APSMediaOverlayPosition value coresponding to the string format.

Declared In

APSMediaOverlay.h

CocoaDocs.org - APSMediaPlayer Class Reference

VeesoPlayer2.0.28

Inherits from KRHub : NSObject
Conforms to GCKDeviceManagerDelegate
GCKDeviceScannerListener
TSMiniWebBrowserDelegate
UIActionSheetDelegate
UIViewControllerAnimatedTransitioning
UIViewControllerTransitioningDelegate
Declared in APSMediaPlayer.h

Overview

The APSMediaPlayer handles playback and rendering of APSMediaUnits and APSMediaOverlays.

Notifications

  • APSMediaPlayerWillEnterFullscreenNotification - Posted before the media player enters fullscreen
  • APSMediaPlayerWillExitFullscreenNotification - Posted before the media player exists 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 unit 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 error 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. See Apple’s documentation on MPMoviePlaybackState for more details about the available playback states.
  • 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
  • APSMediaPlayerInvalidLicenseNotification Posted when the player license is invalid. Playback will be disabled.

Constants

  • kAPSMediaPlayerOverlayControllersGroup - The group name that 3rd party overlay controllers must use when registering with the player.

Tasks

Accessing the APSMediaPlayer Instance and its View

Working with Media Units

Tracking Playback Events

URL Handling

  •   actionDelegate

    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.

         property
  •   modalViewControllerRoot

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

         property
  • – openURL:

    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.
  • – openURL:from:

    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).

Handling Playback

  •   isProcessing

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

         property
  • – play

    Starts playback of the current unit.
  • – pause

    Pauses playback of the current unit.
  • – interrupt
  • – stop

    Stops playback of the current unit.
  • – skip

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

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

    Proceeds to the next unit in the playlist.
  • – previous

    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.
  •   onFinish

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

         property

Getting Playback Information

Getting Video Thumbnails

Handling Fullscreen

Extending

Airplay

Chromecast

Other

Properties

actionDelegate

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

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.

Declared In

APSMediaPlayer.h

advertisingIdentifier

@property (nonatomic) NSString *advertisingIdentifier
Discussion

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

Declared In

APSMediaPlayer.h

allowsAirPlay

@property (nonatomic) BOOL allowsAirPlay
Discussion

Specifies whether the movie player allows AirPlay movie playback.

Declared In

APSMediaPlayer.h

backendPlayer

@property (nonatomic) enum APSBackendPlayer backendPlayer
Discussion

The backend player class. Use [APSAVPlayer class] for the AVPlayer-based backend or [APSMPMoviePlayer class] for the MPMoviePlayerController-based backend

Declared In

APSMediaPlayer.h

backendPlayerClass

@property (nonatomic, strong) Class backendPlayerClass
Discussion

A class which is compliant to APSMediaPlayerProtocol and which will be used as a backend player

Declared In

APSMediaPlayer.h

chromecastAppId

@property (nonatomic) NSString *chromecastAppId
Discussion

Set the Chromecast application ID to be launched when playing via Chromecast

Declared In

APSMediaPlayer.h

detectBreachedDevice

@property (nonatomic, assign) BOOL detectBreachedDevice
Discussion

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

Declared In

APSMediaPlayer.h

fullscreenOnLandscapeRotate

@property (nonatomic) BOOL fullscreenOnLandscapeRotate
Discussion

Enable auto-fullscreen on device orientation

Declared In

APSMediaPlayer.h

ignoreSilentSwitch

@property (nonatomic, assign) BOOL ignoreSilentSwitch
Discussion

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

Declared In

APSMediaPlayer.h

internalFullscreenSupport

@property (nonatomic) BOOL internalFullscreenSupport
Discussion

Set this to NO to disable internal fullscreen handling

Declared In

APSMediaPlayer.h

isFullscreen

@property (nonatomic, readonly) BOOL isFullscreen
Discussion

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

Declared In

APSMediaPlayer.h

isProcessing

@property (nonatomic, readonly) BOOL isProcessing
Discussion

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

Declared In

APSMediaPlayer.h

leaveFullscreenOnStop

@property (nonatomic) BOOL leaveFullscreenOnStop
Discussion

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

Declared In

APSMediaPlayer.h

modalViewControllerRoot

@property (nonatomic, weak) UIViewController *modalViewControllerRoot
Discussion

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

Declared In

APSMediaPlayer.h

onFinish

@property (nonatomic, copy) APSMediaPlayerFinishBlock onFinish
Discussion

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

Declared In

APSMediaPlayer.h

view

@property (nonatomic, readonly) UIView *view
Discussion

The container UIView of the player.

Declared In

APSMediaPlayer.h

Class Methods

durationFromString:

+ (NSTimeInterval)durationFromString:(NSString *)string
Discussion

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

Parameters

string

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

Return Value

The translated time interval in seconds.

Declared In

APSMediaPlayer.h

sharedInstance

+ (instancetype)sharedInstance
Discussion

Returns the shared APSMediaPlayer instance, creating it if necessary.

Return Value

The shared APSMediaPlayer instance

Declared In

APSMediaPlayer.h

Instance Methods

adbreaks

- (NSArray *)adbreaks

addEvents:

- (void)addEvents:(NSArray *)events
Discussion

Adds additional events to the current unit’s timeline.

Parameters

overlays

Additional APSMediaEvent objects to inject.

Declared In

APSMediaPlayer.h

addOverlays:

- (void)addOverlays:(NSArray *)overlays
Discussion

Adds additional overlays to display over the current unit.

Parameters

overlays

Additional APSMediaOverlay objects to inject.

Declared In

APSMediaPlayer.h

airPlayVideoActive

- (BOOL)airPlayVideoActive
Discussion

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

Declared In

APSMediaPlayer.h

chromecastActive

- (BOOL)chromecastActive

chromecastAvailable

- (BOOL)chromecastAvailable
Discussion

Indicates whether there is a Chromecast device available

Declared In

APSMediaPlayer.h

chromecastDevices

- (NSArray *)chromecastDevices
Discussion

Returns a list of detected GCKDevices

Declared In

APSMediaPlayer.h

clear

- (void)clear

connectToChromecastDevice:

- (void)connectToChromecastDevice:(GCKDevice *)device
Discussion

Connect to a specified device

Parameters

device

A GCKDevice to connect to

Declared In

APSMediaPlayer.h

currentChromecastDevice

- (GCKDevice *)currentChromecastDevice
Discussion

Get the current GCKDevice

Declared In

APSMediaPlayer.h

currentChromecastDeviceManager

- (GCKDeviceManager *)currentChromecastDeviceManager
Discussion

Get the current GCKDeviceManager

Declared In

APSMediaPlayer.h

currentChromecastMediaControlChannel

- (GCKMediaControlChannel *)currentChromecastMediaControlChannel
Discussion

Get the current media control channel

Declared In

APSMediaPlayer.h

currentPlaybackTime

- (NSTimeInterval)currentPlaybackTime
Discussion

Returns the current playback time.

Return Value

The current playback time.

Declared In

APSMediaPlayer.h

currentUnit

- (APSMediaUnit *)currentUnit
Discussion

Returns the currently playing media unit.

Return Value

An APSMediaUnit object representing the current unit.

Declared In

APSMediaPlayer.h

disconnectChromecast

- (void)disconnectChromecast

duration

- (NSTimeInterval)duration
Discussion

Returns the current unit’s video clip total duration.

Return Value

The video total duration.

Declared In

APSMediaPlayer.h

enterFullscreen

- (void)enterFullscreen
Discussion

Enter fullscreen mode.

Declared In

APSMediaPlayer.h

exitFullscreen

- (void)exitFullscreen
Discussion

Exit fullscreen mode.

Declared In

APSMediaPlayer.h

getMute

- (BOOL)getMute
Discussion

Get if the player is muted or no

Return Value

The mute status

Declared In

APSMediaPlayer.h

getVolume

- (CGFloat)getVolume
Discussion

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

Return Value

The sound volume of the player

Declared In

APSMediaPlayer.h

hideActivityIndicator

- (void)hideActivityIndicator
Discussion

Hides the player activity indicator.

Declared In

APSMediaPlayer.h

insertMediaUnits:

- (void)insertMediaUnits:(NSArray *)mediaUnits
Discussion

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

Parameters

mediaUnits

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

Declared In

APSMediaPlayer.h

interrupt

- (void)interrupt

isStreamingLive

- (BOOL)isStreamingLive
Discussion

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

Return Value

YES if the player is currently rendering a live stream.

Declared In

APSMediaPlayer.h

loadState

- (MPMovieLoadState)loadState
Discussion

Returns the current unit’s load state. See Apple’s documentation for more details about MPMovieLoadState.

Return Value

The current load state.

Declared In

APSMediaPlayer.h

movieSourceType

- (MPMovieSourceType)movieSourceType
Discussion

Returns the current unit’s movie source type. See Apple’s documentation for more details about MPMovieSourceType.

Return Value

The movie source type.

Declared In

APSMediaPlayer.h

next

- (void)next
Discussion

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

Declared In

APSMediaPlayer.h

openURL:

- (void)openURL:(NSURL *)url
Discussion

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.

Parameters

url

The URL that needs to be loaded.

Declared In

APSMediaPlayer.h

openURL:from:

- (void)openURL:(NSURL *)url from:(APSMediaPlayerOverlayController *)overlayController
Discussion

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).

Parameters

url

The URL that needs to be loaded.

overlay

The calling overlay controller.

Declared In

APSMediaPlayer.h

overlayControllerForType:

- (NSObject<APSMediaPlayerOverlayControllerProtocol> *)overlayControllerForType:(NSString *)type
Discussion

This method instantiates and returns a new object of the class registered for the given overlay type.

Parameters

type

The type of controller required.

Return Value

A new object that implements APSMediaPlayerOverlayControllerProtocol or nil if no controllers are registered for the given type.

Declared In

APSMediaPlayer.h

pause

- (void)pause
Discussion

Pauses playback of the current unit.

Declared In

APSMediaPlayer.h

play

- (void)play
Discussion

Starts playback of the current unit.

Declared In

APSMediaPlayer.h

playMediaUnits:

- (void)playMediaUnits:(NSArray *)mediaUnits
Discussion

Sets and begins playback of an array of media units.

Parameters

mediaUnits

An array of APSMediaUnit objects.

Declared In

APSMediaPlayer.h

playableDuration

- (NSTimeInterval)playableDuration
Discussion

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

Return Value

The video playable duration.

Declared In

APSMediaPlayer.h

playbackState

- (MPMoviePlaybackState)playbackState
Discussion

Returns the current unit’s playback state. See Apple’s documentation for more details about MPMoviePlaybackState.

Return Value

The current playback state.

Declared In

APSMediaPlayer.h

prepareMediaUnits:

- (void)prepareMediaUnits:(NSArray *)mediaUnits
Discussion

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

Parameters

mediaUnits

An array of APSMediaUnit objects.

Declared In

APSMediaPlayer.h

previous

- (void)previous
Discussion

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.

Declared In

APSMediaPlayer.h

registerOverlayController:

- (void)registerOverlayController:(Class<APSMediaPlayerOverlayControllerProtocol>)controllerClass
Discussion

Registers a new overlay controller with the player.

Parameters

controllerClass

The class of the new overlay controller.

Declared In

APSMediaPlayer.h

registerUnitManager:

- (void)registerUnitManager:(NSObject<APSUnitManagerProtocol> *)managerClass
Discussion

Registers a new unit manager to dynamically handle media playback.

Parameters

managerClass

The new unit manager object.

Declared In

APSMediaPlayer.h

replaceCurrentUnitWithUnits:

- (void)replaceCurrentUnitWithUnits:(NSArray *)mediaUnits
Discussion

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

Parameters

mediaUnits

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

Declared In

APSMediaPlayer.h

resetDisplayedOverlays

- (void)resetDisplayedOverlays
Discussion

Resets all displayed overlays.

Declared In

APSMediaPlayer.h

resetDisplayedOverlays:

- (void)resetDisplayedOverlays:(BOOL)animated
Discussion

Resets all displayed overlays.

Declared In

APSMediaPlayer.h

setCurrentPlaybackTime:

- (void)setCurrentPlaybackTime:(NSTimeInterval)playbackTime
Discussion

Sets the current playback time.

Parameters

playbackTime

The playback time to be set.

Declared In

APSMediaPlayer.h

setCurrentURL:

- (void)setCurrentURL:(NSURL *)url
Discussion

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

Parameters

url

The URL of the video clip.

Declared In

APSMediaPlayer.h

setFrame:

- (void)setFrame:(CGRect)frame
Discussion

Call this method to set the player view frame.

Parameters

frame

CGRect player view frame.

Declared In

APSMediaPlayer.h

setMediaUnits:

- (void)setMediaUnits:(NSArray *)mediaUnits
Discussion

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

Parameters

mediaUnits

An array of APSMediaUnit objects to create a new playlist.

Declared In

APSMediaPlayer.h

setMute:

- (void)setMute:(BOOL)mute
Discussion

Mute the player

Parameters

mute

BOOL set YES to mute or NO to unmute.

Declared In

APSMediaPlayer.h

setVolume:

- (void)setVolume:(CGFloat)volume
Discussion

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

Parameters

volume

CGFloat sound volume.

Declared In

APSMediaPlayer.h

showActivityIndicator

- (void)showActivityIndicator
Discussion

Shows an activity indicator, centrally in the player surface.

Declared In

APSMediaPlayer.h

showChromecastDevices

- (void)showChromecastDevices
Discussion

Show an UIActionSheet with detected devices

Declared In

APSMediaPlayer.h

skip

- (void)skip
Discussion

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

Declared In

APSMediaPlayer.h

step

- (void)step
Discussion

Proceeds to the next unit in the playlist.

Declared In

APSMediaPlayer.h

stop

- (void)stop
Discussion

Stops playback of the current unit.

Declared In

APSMediaPlayer.h

thumbnailImageAtTime:

- (UIImage *)thumbnailImageAtTime:(NSTimeInterval)time
Discussion

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

Warning: This method executes blocking operations on the calling thread.

Parameters

time

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

Return Value

The resulting thumbnail.

Declared In

APSMediaPlayer.h

timedMetadata

- (NSArray *)timedMetadata
Discussion

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

Return Value

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

Declared In

APSMediaPlayer.h

toggleFullscreen

- (void)toggleFullscreen
Discussion

Toggle the current fullscreen status.

Declared In

APSMediaPlayer.h

trackEvent:type:forObject:

- (void)trackEvent:(NSString *)event type:(NSString *)type forObject:(id)object
Discussion

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

Declared In

APSMediaPlayer.h

trackEvent:type:forObject:metadata:urls:

- (void)trackEvent:(NSString *)event type:(NSString *)type forObject:(id)object metadata:(NSDictionary *)metadata urls:(id)urls
Discussion

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.

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.

metadata

Additional key-value pairs to send via the notification’s userInfo to subscribers.

urls

An array of NSURL objects representing addresses that should be pinged. Also accepts an array of NSString objects, a single NSURL or a single NSString.

Declared In

APSMediaPlayer.h

unitsForAdbreak:

- (NSArray *)unitsForAdbreak:(APSVASTAdBreak *)adbreak
Discussion

Returns an array of units owned by an APSVASTAdbreak object

Declared In

APSMediaPlayer.h

CocoaDocs.org - APSMediaPlayerButtonOverlayController Class Reference

VeesoPlayer2.0.28

Inherits from APSMediaPlayerOverlayController : UIViewController
Declared in APSMediaPlayerButtonOverlayController.h

Overview

The APSMediaPlayerButtonOverlayController allows placing a transparent overlay in a specific area of the player surface, that can trigger the launch of a specific URL. The APSMediaPlayer instance will query the actionDelegate object to interpret and launch the specified URL. If the actionDelegate cannot respond to the URL, and the URL has a web scheme (http or https), it will be launched automatically in the in-app web browser.

Configuration

To create an APSMediaOverlay of button type:

  • set the overlay object’s type property to APSButtonOverlay

  • set the overlay object’s properties property to a NSDictionary that can have the following keys and values:

    • kAPSButtonOverlayClickthrough: set this key to a NSURL reprezenting the URL that should be launched when the overlay is tapped.
    • kAPSButtonOverlayClicktracking: set this key to a NSArray of NSURL objects that will be tracked by the player when the overlay is tapped (see [APSMediaPlayer track:forEvent:type:]). Note that the kAPSButtonOverlayClickthrough key must also be set for tracking to happen
    • kAPSButtonOverlayWebviewDismissAction: set this key to a NSNumber created from the APSWebviewDismissedAction value that defines the expected playlist behavior on in-app web browser dismiss.
CocoaDocs.org - APSMediaPlayerClosableOverlayController Class Reference

VeesoPlayer2.0.28

Inherits from APSMediaPlayerOverlayController : UIViewController
Declared in APSMediaPlayerClosableOverlayController.h

Overview

The APSMediaPlayerClosableOverlayController class is meant to be a superclass for overlay controllers that need to display a configurable close button to remove the overlay from screen.

The class adds a set of standard keys to any overlay controller’s own defined keys, to handle close button configuration. Methods are also exposed to allow a subclass to add and remove the close button from its view stack.

Tasks

Instance Methods

addCloseButtonWithParameters:

- (void)addCloseButtonWithParameters:(NSDictionary *)parameters
Discussion

This method adds the close button to the current view stack.

The close button is configurable using the provided dictionary structure. Available configuration keys and values are:

  • kAPSCloseImage: if set to a UIImage, that image will be used instead of the standard progress-wheel close button.
  • kAPSCloseSize: a NSNumber reprezenting the lenght of a side of the close button square, in points. Defaults to 16.
  • kAPSCloseBackgroundColor: the background color of the close button view. Set this to a UIColor or a NSString containing the hex color reprezentation. Defaults to [UIColor clearColor].
  • kAPSCloseXColor: the color of the X symbol in the center of the player. Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor darkGrayColor].
  • kAPSCloseProgressColor: the color of the circular bar that indicates the currently elapsed time until the close button can be tapped. Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor darkGrayColor].
  • kAPSCloseProgressTrackColor: the color of the circular bar that indicates the total time until the close button can be tapped. Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor lightGrayColor].
  • kAPSCloseOffsetX: the horizontal offset of the close button, relative to the right margin of the overlay’s view. Set this to a NSNumber. Defaults to 0.
  • kAPSCloseOffsetY: the vertical offset of the close button, relative to the top margin of the overlay’s view. Set this to a NSNumber. Defaults to 0.
  • kAPSCloseInitialAlpha: a NSNumber indicating the opacity of the close button before it is activated for receiving taps. Defaults to 0.5.
  • kAPSCloseFinalAlpha: a NSNumber indicating the opacity of the close button after it has been activated for receiving taps. Defaults to 0.7.
  • kAPSCloseHidden: set this key to @YES to skip displaying the close button for this overlay. Defaults to @NO.
  • kAPSCloseOffset: a NSNumber that indicates the offset, in seconds, after which the close button should become activated for receiving taps. Defaults to 3.
  • kAPSCloseTrackingURLs: a NSArray of NSURLs that will be tracked by the player when the close button is tapped and the overlay is removed (see [APSMediaPlayer track:forEvent:type:]).

Parameters

parameters

A dictionary containing configuration information.

Declared In

APSMediaPlayerClosableOverlayController.h

removeCloseButton

- (void)removeCloseButton
Discussion

This method removes the close button from the current view stack.

Declared In

APSMediaPlayerClosableOverlayController.h

CocoaDocs.org - APSMediaPlayerControlsOverlayController Class Reference

VeesoPlayer2.0.28

Inherits from APSMediaPlayerOverlayController : UIViewController
Declared in APSMediaPlayerControlsOverlayController.h
CocoaDocs.org - APSMediaPlayerHTMLOverlayController Class Reference

VeesoPlayer2.0.28

Inherits from APSMediaPlayerClosableOverlayController : APSMediaPlayerOverlayController : UIViewController
Conforms to UIWebViewDelegate
Declared in APSMediaPlayerHTMLOverlayController.h

Overview

The APSMediaPlayerHTMLOverlayController allows the inline loading of HTML content inside an overlay placed on top of video content.

Configuration

To create an APSMediaOverlay of HTML type:

  • set the overlay object’s type property to APSHTMLOverlay

  • set the overlay object’s properties property to a NSDictionary that can have the following keys and values:

    • kAPSHTMLCodeContent: the actual HTML NSString to be loaded.
    • kAPSHTMLIframeSource: NSString containing the URL that should be loaded inside an iframe element.
    • kAPSHTMLScriptSource: NSString containing the URL of the JavaScript file that should be loaded and executed.
    • kAPSHTMLPageSource: NSString containing the URL to load directly in the webview container.
    • kAPSHTMLWidth: NSNumber corresponding to the integer value to be set for the meta viewport width property.
    • kAPSHTMLHeight: NSNumber corresponding to the integer value to be set for the meta viewport height property.
    • kAPSHTMLErrorURLs: NSArray containing NSURLs to be tracked in case of error.
CocoaDocs.org - APSMediaPlayerImageOverlayController Class Reference

VeesoPlayer2.0.28

Inherits from APSMediaPlayerClosableOverlayController : APSMediaPlayerOverlayController : UIViewController
Declared in APSMediaPlayerImageOverlayController.h

Overview

The APSMediaPlayerImageOverlayController allows placing an image on top of video content.

Configuration

To create an APSMediaOverlay of image type:

  • set the overlay object’s type property to APSImageOverlay

  • set the overlay object’s properties property to a NSDictionary that can have the following keys and values:

    • kAPSImageOverlayClickthrough: set this key to a NSURL reprezenting the URL that should be launched when the overlay is tapped.
    • kAPSImageOverlayClicktracking: set this key to a NSArray of NSURL objects that will be tracked by the player when the overlay is tapped (see [APSMediaPlayer track:forEvent:type:]). Note that the kAPSImageOverlayClickthrough key must also be set for tracking to happen.
    • kAPSImageOverlayWebviewDismissAction: set this key to a NSNumber created from the APSWebviewDismissedAction value that defines the expected playlist behavior on in-app web browser dismiss.
    • kAPSImageOverlayViewtracking: set this key to a NSArray of NSURL objects that will be tracked by the player when the overlay is displayed (see [APSMediaPlayer track:forEvent:type:]).
    • kAPSImageOverlayResourceURL: NSURL reprezenting the image to be loaded.
    • kAPSImageOverlayErrorURLs: set this key to a NSArray of NSURL objects that will be tracked by the player when there is an error loading the image (see [APSMediaPlayer track:forEvent:type:]).
    • kAPSImageOverlayBackgroundColor: the background color of the overlay. Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor clearColor].

    • kAPSImageOverlayStretchMode: NSString reprezenting the possible ways of scaling the image in the overlay surface. Possible values are:

      • “aspectFit”, that will set the overlay’s contentMode to UIViewContentModeScaleAspectFit
      • “aspectFill”, that will set the overlay’s contentMode to UIViewContentModeScaleAspectFill
      • “fill”, that will set the overlay’s contentMode to UIViewContentModeScaleToFill
      • “center”, that will set the overlay’s contentMode to UIViewContentModeCenter
      • “bottom”, that will set the overlay’s contentMode to UIViewContentModeTop
      • “top”, that will set the overlay’s contentMode to UIViewContentModeBottom
      • “left”, that will set the overlay’s contentMode to UIViewContentModeLeft
      • “right”, that will set the overlay’s contentMode to UIViewContentModeRight
CocoaDocs.org - APSMediaPlayerOverlayController Class Reference

VeesoPlayer2.0.28

Inherits from UIViewController
Conforms to APSMediaPlayerOverlayControllerProtocol
Declared in APSMediaPlayerOverlayController.h

Overview

The superclass of all overlay controllers. Implements APSMediaPlayerOverlayControllerProtocol.

Tasks

Properties

overlay

@property (nonatomic, weak) APSMediaOverlay *overlay
Discussion

A reference to the APSMediaOverlay object associated with the current overlay controller.

Declared In

APSMediaPlayerOverlayController.h

CocoaDocs.org - APSMediaPlayerTextOverlayController Class Reference

VeesoPlayer2.0.28

Inherits from APSMediaPlayerOverlayController : UIViewController
Declared in APSMediaPlayerTextOverlayController.h

Overview

The APSMediaPlayerTextOverlayController allows the displaying text on top of video content.

Configuration

To create an APSMediaOverlay of text type:

  • set the overlay object’s type property to APSTextOverlay

  • set the overlay object’s properties property to a NSDictionary that can have the following keys and values:

    • kAPSTextOverlayString: the NSString to be rendered.
    • kAPSTextOverlayStringColor: Font color for the rendered text. Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor whiteColor].
    • kAPSTextOverlayStringFont: NSString indicating the font family to be used. Defaults to @“Helvetica”.
    • kAPSTextOverlayStringSize: NSNumber indicating the font size to be used. Defaults to 13.

Replacable Placeholders

The APSMediaPlayerTextOverlayController will replace the following string placeholders with dynamic information:

  • __remaining__ will be replaced with the remaining number of seconds for the current video clip being rendered.
  • __ad_index__ will be replaced with the current ad index within the ad break.
  • __total_ads__ will be replaced with the total number of ads within the ad break.
CocoaDocs.org - APSMediaPlayerVimeoOverlayController Class Reference

VeesoPlayer2.0.28

Inherits from APSMediaPlayerOverlayController : UIViewController
Conforms to UIWebViewDelegate
Declared in APSMediaPlayerVimeoOverlayController.h
CocoaDocs.org - APSMediaPlayerYoutubeOverlayController Class Reference

VeesoPlayer2.0.28

Inherits from APSMediaPlayerOverlayController : UIViewController
Conforms to UIWebViewDelegate
Declared in APSMediaPlayerYoutubeOverlayController.h
CocoaDocs.org - APSMediaUnit Class Reference

VeesoPlayer2.0.28

Inherits from NSObject
Conforms to APSMediaTrackableObject
NSCopying
Declared in APSMediaUnit.h

Overview

The APSMediaUnit class represents a clip that’s ready to be rendered by the player. A media unit also references an array of APSMediaOverlay objects, defining the overlays connected to the unit.

Tasks

Creating a media unit

Managing the media overlays connected to the current unit

Unit Properties

Ad Handling

  •   seekHandling

    Defines how mid content ads should be handled when the user has skipped over several batches. Use this parameter to instruct the player to render: only the first ad batch, only the last ad batch or all passed ad batches. Defaults to APSHandleSeekEventPlayLastBreak.

         property
  •   midcontentAdMinimumInitialOffset

    For ad breaks assigned to this unit without an ad offset (breaks that should be auto-positioned within the content), this parameter defines the minimum time interval in seconds to wait before displaying the first ad batch. Defaults to 300 seconds.

         property
  •   midcontentAdMinimumFinalOffset

    For ad breaks assigned to this unit without an ad offset (breaks that should be auto-positioned within the content), this parameter defines the minimum time interval in seconds (relative to the end of the video) that should be ad-free. Defaults to 300 seconds.

         property
  •   midcontentAdMinimumSpacing

    For ad breaks assigned to this unit without an ad offset (breaks that should be auto-positioned within the content), this parameter defines the minimum time interval in seconds to wait between ad batches. Defaults to 300 seconds.

         property

Utility Methods

Properties

adbreak

@property (nonatomic, weak) APSVASTAdBreak *adbreak
Discussion

The APSVASTAdBreak objects which created this unit

Declared In

APSMediaUnit.h

buffet

@property (nonatomic) NSMutableArray *buffet
Discussion

An array of other media units to be played instead of the current one, should an error be encountered. The unit at index 0 has the highest priority.

Declared In

APSMediaUnit.h

canReplay

@property (nonatomic) BOOL canReplay
Discussion

Defines whether the player can replay the current unit or not after it has ended in the playlist.

Declared In

APSMediaUnit.h

controlsDisplay

@property (nonatomic) APSMediaControlsDisplay controlsDisplay
Discussion

Defines how the controls bar will be displayed for the unit. See APSMediaControlsDisplay for possible values.

Declared In

APSMediaUnit.h

controlsParameters

@property (nonatomic) NSDictionary *controlsParameters
Discussion

The configuration for the controls bar overlay.

The following keys are available:

  • kAPSControlsBarColor: Set this to a UIColor that represents the background color of the controls bar.
  • kAPSControlsBarAlpha: NSNumber that represents the opacity of the controls bar.
  • kAPSControlsComponents: Set this to a mask that you get using OR operations on APSControlsOverlayComponents constants.
  • kAPSControlsPlayedTrackColor: The UIColor of the portion of the seek bar that indicates the currently played duration of the movie.
  • kAPSControlsBufferedTrackColor: The UIColor of the portion of the seek bar that indicates the currently buffered duration of the movie.
  • kAPSControlsEmptyTrackColor: The UIColor of the portion of the seek bar that indicates the currently unbuffered duration of the movie.
  • kAPSControlsPlayImage: The UIImage of the play button to use in the playback controls bar. Only displayed if the playback component is selected.
  • kAPSControlsPauseImage: The UIImage of the pause button to use in the playback controls bar. Only displayed if the playback component is selected.
  • kAPSControlsFullscreenImage: The UIImage of the fullscreen button to use in the playback controls bar. Only displayed if the playback component is selected.
  • kAPSControlsPreviousImage: The UIImage of the back button to use in the playback controls bar. Only displayed if the back button component is selected.
  • kAPSControlsNextImage: The UIImage of the forward button to use in the playback controls bar. Only displayed if the forward button component is selected.
  • kAPSControlsVisibileOnlyInFullscreen: Defines whether the playback controls bar should only be visible while the player is in fullscreen mode. This is useful if implementing a custom player UX for normal mode. Set this to a NSNumber boolean.
  • kAPSControlsAutohideDuration: The number of seconds the playback controls bar should automatically become hidden after. Set this to a NSNumber.
  • kAPSControlsLiveText: The text to display instead of the total video duration, for live streams. Only has effect when the total duration component is selected. Defaults to @"LIVE".
  • kAPSControlsPlaybackTimeText: The text to display instead of the current playback time, for live streams. Only has effect when the current playback time component is selected.
  • kAPSControlsUpdateCurrentTimeWhileSeeking: The current time text is showing the current seek position when dragging the seek bar

Declared In

APSMediaUnit.h

debug

@property (nonatomic) BOOL debug
Discussion

Toggle to enable logs.

Declared In

APSMediaUnit.h

initialPlaybackTime

@property (nonatomic) NSTimeInterval initialPlaybackTime
Discussion

Initial video playback time in seconds.

Declared In

APSMediaUnit.h

managerType

@property (nonatomic) NSString *managerType
Discussion

Assigns a unit manager to the current unit. See APSUnitManagerProtocol for more information.

Declared In

APSMediaUnit.h

metadata

@property (nonatomic) NSMutableDictionary *metadata
Discussion

Additional unit key-value information.

Declared In

APSMediaUnit.h

midcontentAdMinimumFinalOffset

@property (nonatomic, assign) NSTimeInterval midcontentAdMinimumFinalOffset
Discussion

For ad breaks assigned to this unit without an ad offset (breaks that should be auto-positioned within the content), this parameter defines the minimum time interval in seconds (relative to the end of the video) that should be ad-free. Defaults to 300 seconds.

Declared In

APSMediaUnit.h

midcontentAdMinimumInitialOffset

@property (nonatomic, assign) NSTimeInterval midcontentAdMinimumInitialOffset
Discussion

For ad breaks assigned to this unit without an ad offset (breaks that should be auto-positioned within the content), this parameter defines the minimum time interval in seconds to wait before displaying the first ad batch. Defaults to 300 seconds.

Declared In

APSMediaUnit.h

midcontentAdMinimumSpacing

@property (nonatomic, assign) NSTimeInterval midcontentAdMinimumSpacing
Discussion

For ad breaks assigned to this unit without an ad offset (breaks that should be auto-positioned within the content), this parameter defines the minimum time interval in seconds to wait between ad batches. Defaults to 300 seconds.

Declared In

APSMediaUnit.h

pinchToFullscreen

@property (nonatomic) BOOL pinchToFullscreen
Discussion

Defines if pinch-to-fullscreen should be allowed.

Declared In

APSMediaUnit.h

scalingMode

@property (nonatomic) MPMovieScalingMode scalingMode
Discussion

The video clip scaling mode, relative to the player surface. See Apple’s documentation for more details on MPMovieScalingMode. Defaults to MPMovieScalingModeNone.

Declared In

APSMediaUnit.h

seekHandling

@property (nonatomic, assign) APSHandleSeekEvent seekHandling
Discussion

Defines how mid content ads should be handled when the user has skipped over several batches. Use this parameter to instruct the player to render: only the first ad batch, only the last ad batch or all passed ad batches. Defaults to APSHandleSeekEventPlayLastBreak.

Declared In

APSMediaUnit.h

shouldAutoplay

@property (nonatomic) BOOL shouldAutoplay
Discussion

Defines if the unit should start playing as soon as it loads or wait for a play command.

Declared In

APSMediaUnit.h

url

@property (nonatomic) NSURL *url
Discussion

The video clip URL.

Declared In

APSMediaUnit.h

Class Methods

scalingModeFromString:

+ (MPMovieScalingMode)scalingModeFromString:(NSString *)string
Discussion

Converts a string format to a MPMovieScalingMode value. See Apple’s documentation for more details on MPMovieScalingMode.

Possible input values are:

  • “aspectFit”, that will be converted to MPMovieScalingModeAspectFit
  • “aspectFill”, that will be converted to MPMovieScalingModeAspectFill
  • “fill”, that will be converted to MPMovieScalingModeFill

Parameters

string

A string format to be converted.

Return Value

A MPMovieScalingMode value.

Declared In

APSMediaUnit.h

Instance Methods

addEvent:

- (void)addEvent:(APSMediaEvent *)overlay
Discussion

Adds an object that implements the APSMediaEvent protocol to the unit.

Parameters

overlay

The event to be connected to the unit.

Declared In

APSMediaUnit.h

addOverlay:

- (void)addOverlay:(APSMediaOverlay *)overlay
Discussion

Adds an APSMediaOverlay object to the unit, to be rendered together.

Parameters

overlay

The APSMediaOverlay object to be connected to the unit.

Declared In

APSMediaUnit.h

clearEvents

- (void)clearEvents
Discussion

Removes all currently connected events.

Declared In

APSMediaUnit.h

clearOverlays

- (void)clearOverlays
Discussion

Removes all currently connected overlays.

Declared In

APSMediaUnit.h

dynamicEvents

- (NSArray *)dynamicEvents

events

- (NSArray *)events
Discussion

Returns an array containing all event objects currently connected to the unit.

Return Value

An array of objects that implement the APSMediaEvent protocol.

Declared In

APSMediaUnit.h

initWithURL:

- (APSMediaUnit *)initWithURL:(NSURL *)url
Discussion

Initializes a media unit object.

Parameters

url

The video clip URL.

Return Value

A new APSMediaUnit object

Declared In

APSMediaUnit.h

overlays

- (NSArray *)overlays
Discussion

Returns an array containing all APSMediaOverlay objects currently connected to the unit.

Return Value

An array of APSMediaOverlay objects.

Declared In

APSMediaUnit.h

removeEvent:

- (void)removeEvent:(APSMediaEvent *)event
Discussion

Removes a specific media event.

Declared In

APSMediaUnit.h

setEvents:

- (void)setEvents:(NSArray *)events
Discussion

Connects an array of objects that implement the APSMediaEvent protocol to the current unit.

Parameters

overlays

An array of events to be connected to the unit.

Declared In

APSMediaUnit.h

setOverlays:

- (void)setOverlays:(NSArray *)overlays
Discussion

Connects an array of APSMediaOverlay objects to the current unit.

Parameters

overlays

An array of APSMediaOverlay objects to be connected to the unit.

Declared In

APSMediaUnit.h

CocoaDocs.org - APSTimedMetadata Class Reference

VeesoPlayer2.0.28

Inherits from MPTimedMetadata
Declared in APSTimedMetadata.h

Tasks

APSTimedMetadata initialization

Instance Methods

initWithMetadataItem:

- (id)initWithMetadataItem:(AVMetadataItem *)item
Discussion

Create and return a new APSTimedMetadata instance based on an AVMetadataItem

Parameters

item

An AVMetadataItem instance

Declared In

APSTimedMetadata.h

CocoaDocs.org - APSVASTAdBreak Class Reference

VeesoPlayer2.0.28

Inherits from APSMediaEvent : NSObject
Conforms to APSMediaTrackableObject
NSCopying
Declared in APSVASTAdBreak.h

Overview

An APSVASTAdBreak object defines an ad break for which the builder plugin will try to generate APSMediaUnits and insert them into the playlist.

Tasks

Main Configuration

  •   sources

    An array of NSString objects indicating the VAST URLs that will be called in order to populate the ad break with ads.

         property
  •   type

    The ad break type. Specifies how the rezulting APSMediaUnits and APSMediaOverlays need to be placed relative to the main content units. See APSVASTConfigurationOptions for more details about the possible values.

         property
  •   adOffset

    A string format that defines when midrolls and nonlinear ads should be inserted mid-unit for each content unit.

         property
  •   repeatAfter

    Defines the time interval in seconds after which the ad break will be repeated.

         property
  •   userAgent

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

         property
  • – configureFromDictionary:

    Configure an AdBreak from a dictionary structure.

Configuring the Playback Controls Bar

VAST 3.0 Icon Support

  •   defaultIconHeightPercentage

    Icons are rendered to a height that’s proportional to the current player view height. This property defines the percentage of the current height to render ads to, while preserving the original aspect ration in calculating the rendered width.

         property
  •   iconFadeInDuration

    The fade-in animation duration for displaying icons, in seconds.

         property

Skip Button Configuration

Fullscreen Button Configuration

Countdown to Next Unit Overlay Configuration

Ad Retrieval Settings

  •   allowMultipleAds

    Defines whether the break should allow more than one ad to be played, even if more ads are retrieved.

         property
  •   followWrappers

    Defines whether VAST Wrappers should be followed for the given URL sources.

         property
  •   multipleAdsConflictsPolicy

    The VMAP standard permits allowing only one ad from a certain ad source. This constant defines how the VAST builder plugin deals with situations when multiple valid ads are retrieved from a source that is disallowed to load several ads at one time.

         property
  •   adPodFallbackStrategy

    VAST 3.0 defines Ad Pods, with fallback mechanisms that allow loading an ad buffet of commercials to playback if the main ads fail. This value specifies how to treat backwards compatibility issues with VAST 2.0 and 1.0, by choosing what ads are promoted to the main Ad Pod if no valid Pods are detected.

         property
  •   prefferedVideoMimeTypes

    An array that defines the mime-types supported when choosing a media file from the VAST response.

         property

Other Configurations

  •   scalingMode

    The ad video clip scaling mode, relative to the player surface.

         property
  •   allowPinchToFullscreen

    Defines if the pinch-to-fullscreen gesture should be activated for generated video ads.

         property
  •   afterBannerTapped

    Defines the behavior of the player after a banner ad is tapped and the built-in web browser is dismissed.

         property
  •   afterVideoAdTapped

    Defines the behavior of the player after a video ad is tapped and the built-in web browser is dismissed.

         property
  •   debug

    Defines if the break should log debug information to the console.

         property
  •   metadata property

Properties

adOffset

@property (nonatomic) NSString *adOffset
Discussion

A string format that defines when midrolls and nonlinear ads should be inserted mid-unit for each content unit.

The expected format for this property is: “seconds” or “percentage%”.

Declared In

APSVASTAdBreak.h

adPodFallbackStrategy

@property (nonatomic) APSAdPodFallback adPodFallbackStrategy
Discussion

VAST 3.0 defines Ad Pods, with fallback mechanisms that allow loading an ad buffet of commercials to playback if the main ads fail. This value specifies how to treat backwards compatibility issues with VAST 2.0 and 1.0, by choosing what ads are promoted to the main Ad Pod if no valid Pods are detected.

See APSAdPodFallback for possible values. Defaults to APSAdPodFallbackSelectAll.

Declared In

APSVASTAdBreak.h

afterBannerTapped

@property (nonatomic) APSWebviewDismissedAction afterBannerTapped
Discussion

Defines the behavior of the player after a banner ad is tapped and the built-in web browser is dismissed.

Declared In

APSVASTAdBreak.h

afterVideoAdTapped

@property (nonatomic) APSWebviewDismissedAction afterVideoAdTapped
Discussion

Defines the behavior of the player after a video ad is tapped and the built-in web browser is dismissed.

Declared In

APSVASTAdBreak.h

allowMultipleAds

@property (nonatomic) BOOL allowMultipleAds
Discussion

Defines whether the break should allow more than one ad to be played, even if more ads are retrieved.

Declared In

APSVASTAdBreak.h

allowPinchToFullscreen

@property (nonatomic) BOOL allowPinchToFullscreen
Discussion

Defines if the pinch-to-fullscreen gesture should be activated for generated video ads.

Defaults to YES;

Declared In

APSVASTAdBreak.h

bannerConfiguration

@property (nonatomic) APSVASTBannerConfiguration *bannerConfiguration
Discussion

@name Non-linear Ads Configuration

Declared In

APSVASTAdBreak.h

controlsDisplayForAds

@property (nonatomic) APSMediaControlsDisplay controlsDisplayForAds
Discussion

Specifies how the controls bar will be displayed on top of video ads.

See APSMediaControlsDisplay for more details. Defaults to APSMediaControlsDisplayNone.

Declared In

APSVASTAdBreak.h

controlsParametersForAds

@property (nonatomic) NSDictionary *controlsParametersForAds
Discussion

The configuration for the controls bar overlay on top of video ads.

See [APSMediaUnit controlsParameters] for details on creating this dictionary.

Declared In

APSVASTAdBreak.h

countdownConfiguration

@property (nonatomic) APSVASTCountdownConfiguration *countdownConfiguration
Discussion

Holds the configuration object for the countdown overlay that appears on top of video ads.

Declared In

APSVASTAdBreak.h

debug

@property (nonatomic) BOOL debug
Discussion

Defines if the break should log debug information to the console.

Declared In

APSVASTAdBreak.h

defaultIconHeightPercentage

@property (nonatomic) CGFloat defaultIconHeightPercentage
Discussion

Icons are rendered to a height that’s proportional to the current player view height. This property defines the percentage of the current height to render ads to, while preserving the original aspect ration in calculating the rendered width.

Defaults to 10.

Declared In

APSVASTAdBreak.h

followWrappers

@property (nonatomic) BOOL followWrappers
Discussion

Defines whether VAST Wrappers should be followed for the given URL sources.

Declared In

APSVASTAdBreak.h

fullscreenButtonConfiguration

@property (nonatomic) APSVASTFullscreenButtonConfiguration *fullscreenButtonConfiguration
Discussion

Holds the configuration object for the fullscreen button that appears on top of video ads.

Declared In

APSVASTAdBreak.h

iconFadeInDuration

@property (nonatomic) CGFloat iconFadeInDuration
Discussion

The fade-in animation duration for displaying icons, in seconds.

Defaults to 0.5.

Declared In

APSVASTAdBreak.h

metadata

@property (nonatomic) NSMutableDictionary *metadata

multipleAdsConflictsPolicy

@property (nonatomic) APSResolvMultipleAdsConflictsBy multipleAdsConflictsPolicy
Discussion

The VMAP standard permits allowing only one ad from a certain ad source. This constant defines how the VAST builder plugin deals with situations when multiple valid ads are retrieved from a source that is disallowed to load several ads at one time.

See APSResolvMultipleAdsConflictsBy for possible values. Defaults to APSResolvMultipleAdsConflictsBySelectingFirst.

Declared In

APSVASTAdBreak.h

prefferedVideoMimeTypes

@property (nonatomic) NSArray *prefferedVideoMimeTypes
Discussion

An array that defines the mime-types supported when choosing a media file from the VAST response.

Items are ordered from most preferred to least preferred. The default value for this property is @[@"mobile/m3u8",@"application/x-mpegURL",@"application/vnd.apple.mpegURL",@"vnd.apple.mpegURL",@"video/m3u8",@"mobile/mp4",@"video/mp4"]

Declared In

APSVASTAdBreak.h

repeatAfter

@property (nonatomic) NSTimeInterval repeatAfter
Discussion

Defines the time interval in seconds after which the ad break will be repeated.

Declared In

APSVASTAdBreak.h

scalingMode

@property (nonatomic) MPMovieScalingMode scalingMode
Discussion

The ad video clip scaling mode, relative to the player surface.

See Apple’s documentation for more details on MPMovieScalingMode. Defaults to MPMovieScalingModeNone.

Declared In

APSVASTAdBreak.h

skipButtonConfiguration

@property (nonatomic) APSVASTSkipButtonConfiguration *skipButtonConfiguration
Discussion

Holds the configuration object for the skip button that appears on top of video ads.

Declared In

APSVASTAdBreak.h

sources

@property (nonatomic) NSArray *sources
Discussion

An array of NSString objects indicating the VAST URLs that will be called in order to populate the ad break with ads.

Declared In

APSVASTAdBreak.h

type

@property (nonatomic) APSVASTAdBreakType type
Discussion

The ad break type. Specifies how the rezulting APSMediaUnits and APSMediaOverlays need to be placed relative to the main content units. See APSVASTConfigurationOptions for more details about the possible values.

Declared In

APSVASTAdBreak.h

userAgent

@property (nonatomic) NSString *userAgent
Discussion

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

Declared In

APSVASTAdBreak.h

Instance Methods

configureFromDictionary:

- (void)configureFromDictionary:(NSDictionary *)configuration
Discussion

Configure an AdBreak from a dictionary structure.

Parameters

configuration

Configuration dictionary.

Declared In

APSVASTAdBreak.h

CocoaDocs.org - APSVASTBannerConfiguration Class Reference

VeesoPlayer2.0.28

Inherits from NSObject
Conforms to NSCopying
Declared in APSVASTBannerConfiguration.h

Overview

Holds all configuration parameters for the banner ads displayed.

Tasks
  •   maxSize

    The maximum allowed size for a non-linear ad. Non-linear ads that define sizes larger than this will be truncated.

         property
  •   stretchToMaxSize

    Defines if non-linear ads should be stretched to the defined bannerMaxSize, should they declare a size smaller than that.

         property
  •   position

    Defines how a non-linear banner overlay should be placed relative to the player surface.

         property
  •   fadeInDuration

    Defines the fade-in animation duration for non-linear ads.

         property
  •   defaultAdBreakDuration

    Defines the default number of seconds that a non-linear ad will be kept on display. This can be overridden by VAST ad configuration.

         property
  •   skipOffset

    Defines the default number of seconds after which the non-linear ad close button becomes active.

         property
  •   showCloseButton

    Indicates whether a close button should be displayed on top of non-linear ads.

         property
  •   closeButtonImage

    Defines the image that should be displayed in the non-linear ads close button, instead of the default progress wheel.

         property
  •   closeButtonBackgroundColor

    Defines the background color for the close button displayed on top of non-linear ads.

         property
  •   closeButtonXColor

    Defines the color for the X symbol in the center of the close button.

         property
  •   closeButtonSize

    Indicates the lenght of a side of the non-linear ads close button square.

         property
  •   closeButtonInitialAlpha

    Indicates the opacity of the non-linear ads close button before it is activated for receiving taps.

         property
  •   closeButtonFinalAlpha

    Indicates the opacity of the non-linear close button after it has been activated for receiving taps.

         property
  •   closeButtonProgressColor

    The color of the circular bar that indicates the currently elapsed time until the close button can be tapped.

         property
  •   closeButtonTrackColor

    The color of the circular bar that indicates the total time until the close button can be tapped.

         property
  •   closeButtonOffset

    Defines the offset that the non-linear ads close button should have from the top-right edge of the banner itself.

         property

Properties

closeButtonBackgroundColor

@property (nonatomic) NSString *closeButtonBackgroundColor
Discussion

Defines the background color for the close button displayed on top of non-linear ads.

Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor clearColor].

Declared In

APSVASTBannerConfiguration.h

closeButtonFinalAlpha

@property (nonatomic) float closeButtonFinalAlpha
Discussion

Indicates the opacity of the non-linear close button after it has been activated for receiving taps.

Defaults to 0.7.

Declared In

APSVASTBannerConfiguration.h

closeButtonImage

@property (nonatomic) UIImage *closeButtonImage
Discussion

Defines the image that should be displayed in the non-linear ads close button, instead of the default progress wheel.

Declared In

APSVASTBannerConfiguration.h

closeButtonInitialAlpha

@property (nonatomic) float closeButtonInitialAlpha
Discussion

Indicates the opacity of the non-linear ads close button before it is activated for receiving taps.

Defaults to 0.5.

Declared In

APSVASTBannerConfiguration.h

closeButtonOffset

@property (nonatomic) CGPoint closeButtonOffset
Discussion

Defines the offset that the non-linear ads close button should have from the top-right edge of the banner itself.

Declared In

APSVASTBannerConfiguration.h

closeButtonProgressColor

@property (nonatomic) NSString *closeButtonProgressColor
Discussion

The color of the circular bar that indicates the currently elapsed time until the close button can be tapped.

Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor darkGrayColor].

Declared In

APSVASTBannerConfiguration.h

closeButtonSize

@property (nonatomic) int closeButtonSize
Discussion

Indicates the lenght of a side of the non-linear ads close button square.

Defaults to 20.

Declared In

APSVASTBannerConfiguration.h

closeButtonTrackColor

@property (nonatomic) NSString *closeButtonTrackColor
Discussion

The color of the circular bar that indicates the total time until the close button can be tapped.

Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor lightGrayColor].

Declared In

APSVASTBannerConfiguration.h

closeButtonXColor

@property (nonatomic) NSString *closeButtonXColor
Discussion

Defines the color for the X symbol in the center of the close button.

Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor darkGrayColor].

Declared In

APSVASTBannerConfiguration.h

defaultAdBreakDuration

@property (nonatomic) int defaultAdBreakDuration
Discussion

Defines the default number of seconds that a non-linear ad will be kept on display. This can be overridden by VAST ad configuration.

Defaults to 10.

Declared In

APSVASTBannerConfiguration.h

fadeInDuration

@property (nonatomic) CGFloat fadeInDuration
Discussion

Defines the fade-in animation duration for non-linear ads.

Defaults to 0.5.

Declared In

APSVASTBannerConfiguration.h

maxSize

@property (nonatomic) CGSize maxSize
Discussion

The maximum allowed size for a non-linear ad. Non-linear ads that define sizes larger than this will be truncated.

Defaults to CGSizeMake(320, 50).

Declared In

APSVASTBannerConfiguration.h

position

@property (nonatomic) APSMediaOverlayPosition position
Discussion

Defines how a non-linear banner overlay should be placed relative to the player surface.

See APSMediaOverlayPosition for possible values. Defaults to kAPSMediaOverlayPositionBottom.

Declared In

APSVASTBannerConfiguration.h

showCloseButton

@property (nonatomic) BOOL showCloseButton
Discussion

Indicates whether a close button should be displayed on top of non-linear ads.

Defaults to YES.

Declared In

APSVASTBannerConfiguration.h

skipOffset

@property (nonatomic) int skipOffset
Discussion

Defines the default number of seconds after which the non-linear ad close button becomes active.

Defaults to 3.

Declared In

APSVASTBannerConfiguration.h

stretchToMaxSize

@property (nonatomic) BOOL stretchToMaxSize
Discussion

Defines if non-linear ads should be stretched to the defined bannerMaxSize, should they declare a size smaller than that.

Defaults to NO;

Declared In

APSVASTBannerConfiguration.h

CocoaDocs.org - APSVASTCountdownConfiguration Class Reference

VeesoPlayer2.0.28

Inherits from NSObject
Conforms to NSCopying
Declared in APSVASTCountdownConfiguration.h

Overview

Holds all configuration parameters for the coundown overlay displayed on top of video ads.

Tasks
  •   show

    Indicates whether the countdown until the next media starts should be displayed during video ads.

         property
  •   position

    The position of the countdown overlay, relative to the player surface.

         property
  •   text

    The text to be displayed in the countdown overlay. Use the “remaining” placeholder for the number of seconds.

         property
  •   width

    The width of the countdown overlay.

         property
  •   height
    • The height of the countdown overlay.
         property
  •   font

    The font family to be used for the text in the countdown overlay.

         property
  •   size

    The size of the font to be used for the text in the countdown overlay.

         property
  •   color

    The color of the font to be used for the text in the countdown overlay.

         property

Properties

color

@property (nonatomic) NSString *color
Discussion

The color of the font to be used for the text in the countdown overlay.

Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor whiteColor].

Declared In

APSVASTCountdownConfiguration.h

font

@property (nonatomic) NSString *font
Discussion

The font family to be used for the text in the countdown overlay.

Defaults to @“Helvetica”.

Declared In

APSVASTCountdownConfiguration.h

height

@property (nonatomic) NSString *height
Discussion
  • The height of the countdown overlay.

Defaults to @“30”.

Declared In

APSVASTCountdownConfiguration.h

position

@property (nonatomic) APSMediaOverlayPosition position
Discussion

The position of the countdown overlay, relative to the player surface.

See APSMediaOverlayPosition for possible values. Defaults to kAPSMediaOverlayPositionBottomLeft.

Declared In

APSVASTCountdownConfiguration.h

show

@property (nonatomic) BOOL show
Discussion

Indicates whether the countdown until the next media starts should be displayed during video ads.

Defaults to YES;

Declared In

APSVASTCountdownConfiguration.h

size

@property (nonatomic) int size
Discussion

The size of the font to be used for the text in the countdown overlay.

Defaults to 13.

Declared In

APSVASTCountdownConfiguration.h

text

@property (nonatomic) NSString *text
Discussion

The text to be displayed in the countdown overlay. Use the “remaining” placeholder for the number of seconds.

Declared In

APSVASTCountdownConfiguration.h

width

@property (nonatomic) NSString *width
Discussion

The width of the countdown overlay.

Defaults to @“64%”.

Declared In

APSVASTCountdownConfiguration.h

CocoaDocs.org - APSVASTFullscreenButtonConfiguration Class Reference

VeesoPlayer2.0.28

Inherits from NSObject
Conforms to NSCopying
Declared in APSVASTFullscreenButtonConfiguration.h

Tasks
  •   visible

    .

         property
  •   position

    The position of the fullscreen ad overlay, relative to the player surface.

         property
  •   padding

    The internal padding that the fullscreen overlay should apply to its content.

         property
  •   enterIconLocation

    An URL to the icon or a UIImage instance which will be used for the “enter fullscreen” action

         property
  •   leaveIconLocation

    An URL to the icon or a UIImage instance which will be used for the “leave fullscreen” action

         property
  •   borderColor

    The color of the border for the fullscreen overlay.

         property
  •   borderRadius

    The corner radius of the border for the fullscreen overlay.

         property
  •   backgroundColor

    The background color for the fullscreen overlay.

         property
  •   width

    The width of the fullscreen overlay.

         property
  •   height

    The height of the fullscreen overlay.

         property

Properties

backgroundColor

@property (nonatomic) NSString *backgroundColor
Discussion

The background color for the fullscreen overlay.

Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor clearColor].

Declared In

APSVASTFullscreenButtonConfiguration.h

borderColor

@property (nonatomic) NSString *borderColor
Discussion

The color of the border for the fullscreen overlay.

Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor lightGrayColor].

Declared In

APSVASTFullscreenButtonConfiguration.h

borderRadius

@property (nonatomic) int borderRadius
Discussion

The corner radius of the border for the fullscreen overlay.

Defaults to 5.

Declared In

APSVASTFullscreenButtonConfiguration.h

enterIconLocation

@property (nonatomic, strong) id enterIconLocation
Discussion

An URL to the icon or a UIImage instance which will be used for the “enter fullscreen” action

Defaults to APSMediaPlayer.bundle/Controls/fullscreen.png

Declared In

APSVASTFullscreenButtonConfiguration.h

height

@property (nonatomic) NSString *height
Discussion

The height of the fullscreen overlay.

Defaults to @“30”.

Declared In

APSVASTFullscreenButtonConfiguration.h

leaveIconLocation

@property (nonatomic, strong) id leaveIconLocation
Discussion

An URL to the icon or a UIImage instance which will be used for the “leave fullscreen” action

Defaults to APSMediaPlayer.bundle/Controls/fullscreen-exit.png

Declared In

APSVASTFullscreenButtonConfiguration.h

padding

@property (nonatomic) int padding
Discussion

The internal padding that the fullscreen overlay should apply to its content.

Defaults to 5.

Declared In

APSVASTFullscreenButtonConfiguration.h

position

@property (nonatomic) APSMediaOverlayPosition position
Discussion

The position of the fullscreen ad overlay, relative to the player surface.

See APSMediaOverlayPosition for possible values. Defaults to kAPSMediaOverlayPositionBottomRight.

Declared In

APSVASTFullscreenButtonConfiguration.h

visible

@property (nonatomic) BOOL visible
Discussion

.

See APSMediaOverlayPosition for possible values. Defaults to kAPSMediaOverlayPositionBottomRight.

Declared In

APSVASTFullscreenButtonConfiguration.h

width

@property (nonatomic) NSString *width
Discussion

The width of the fullscreen overlay.

Defaults to @“75”.

Declared In

APSVASTFullscreenButtonConfiguration.h

CocoaDocs.org - APSVASTFullscreenOverlayController Class Reference

VeesoPlayer2.0.28

Inherits from APSMediaPlayerOverlayController : UIViewController
Declared in APSVASTFullscreenOverlayController.h
CocoaDocs.org - APSVASTMediaBuilderPlugin Class Reference

VeesoPlayer2.0.28

Inherits from NSObject
Conforms to APSMediaBuilderPlugin
Declared in APSVASTMediaBuilderPlugin.h

Overview

The VAST Media Builder plugin extends an APSMediaBuilder object by inserting preroll, postroll, midroll and non-linear ad breaks, loaded from VAST 1.0, VAST 2.0, VAST 3.0 and VMAP 1.0 sources.

Use the [APSMediaBuilder addPlugin:] method to attach an APSVASTMediaBuilderPlugin object to a media builder.

Configuration of the plugin can be done in three ways:

  • programatically configure the plugin object, using available properties;
  • configure the plugin object directly, using a dictionary - see [APSMediaBuilderPlugin configureFromDictionary:];
  • configure the plugin with JSON. This is done as part of the APSMediaBuilder object configuration from JSON or from a dictionary. If the supplied configuration dictionary or interpreted JSON dictionary contains the “ads” key, then the corresponding value dictionary for that key will be provided to the plugin for configuration.

Tasks

Other Methods

Configuring Ad Breaks

  •   vmapURL

    The VMAP 1.0 URL that should be used to configure ad breaks.

         property
  •   adBreakTemplate

    The template object that holds default parameter values for ad breaks created from VMAP or VAST.

         property
  •   adBreaks

    The currently defined ad breaks that the plugin will try to fill.

         property

Other Configurations

  •   defaultAdBreakPositions

    When loading ads via VMAP and using ad break positioning via “#”, this array defines the available, pre-defined positions that ads can be inserted at.

         property

Properties

adBreakTemplate

@property (nonatomic) APSVASTAdBreak *adBreakTemplate
Discussion

The template object that holds default parameter values for ad breaks created from VMAP or VAST.

Declared In

APSVASTMediaBuilderPlugin.h

adBreaks

@property (nonatomic) NSArray *adBreaks
Discussion

The currently defined ad breaks that the plugin will try to fill.

Declared In

APSVASTMediaBuilderPlugin.h

defaultAdBreakPositions

@property (nonatomic) NSArray *defaultAdBreakPositions
Discussion

When loading ads via VMAP and using ad break positioning via “#”, this array defines the available, pre-defined positions that ads can be inserted at.

Positions are defined using strings that can either specify absolute time intervals in seconds (e.g.: @“10”) or percentual values, relative to the full playback time (e.g.: @“50%”). Defaults to @[@"5", @"75%"].

Declared In

APSVASTMediaBuilderPlugin.h

vmapURL

@property (nonatomic) NSURL *vmapURL
Discussion

The VMAP 1.0 URL that should be used to configure ad breaks.

Declared In

APSVASTMediaBuilderPlugin.h

Instance Methods

adBreaksForVMAP

- (NSArray *)adBreaksForVMAP
CocoaDocs.org - APSVASTSkipButtonConfiguration Class Reference

VeesoPlayer2.0.28

Inherits from NSObject
Conforms to NSCopying
Declared in APSVASTSkipButtonConfiguration.h

Overview

Holds all configuration parameters for the skip button displayed on top of video ads

Tasks
  •   position

    The position of the skip ad overlay, relative to the player surface.

         property
  •   defaultSkipOffset

    The default interval of time that needs to pass before the skip overlay is activated for tapping.

         property
  •   text

    The text that should be displayed in the skip button.

         property
  •   textColor

    The color of the text diplayed in the skip button.

         property
  •   progressPosition

    Defines where inside the skip overlay should the progress circle be rendered.

         property
  •   progressCircleColor

    Defines the color of the progress bar indicating the elapsed time since ad has started.

         property
  •   progressCircleTextColor

    Defines the color of the text in the middle of the progress circle, indicating the number of seconds left until skip activation.

         property
  •   progressCircleTrackColor

    Defines the color of the progress bar indicating the total duration of the ad.

         property
  •   padding

    The internal padding that the skip overlay should apply to its content.

         property
  •   borderColor

    The color of the border for the skip overlay.

         property
  •   borderRadius

    The corner radius of the border for the skip overlay.

         property
  •   backgroundColor

    The background color for the skip overlay.

         property
  •   width

    The width of the skip overlay.

         property
  •   height

    The height of the skip overlay.

         property

Properties

backgroundColor

@property (nonatomic) NSString *backgroundColor
Discussion

The background color for the skip overlay.

Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor clearColor].

Declared In

APSVASTSkipButtonConfiguration.h

borderColor

@property (nonatomic) NSString *borderColor
Discussion

The color of the border for the skip overlay.

Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor lightGrayColor].

Declared In

APSVASTSkipButtonConfiguration.h

borderRadius

@property (nonatomic) int borderRadius
Discussion

The corner radius of the border for the skip overlay.

Defaults to 5.

Declared In

APSVASTSkipButtonConfiguration.h

defaultSkipOffset

@property (nonatomic) int defaultSkipOffset
Discussion

The default interval of time that needs to pass before the skip overlay is activated for tapping.

The default value is -1, which makes the skip button invisible.

Declared In

APSVASTSkipButtonConfiguration.h

height

@property (nonatomic) NSString *height
Discussion

The height of the skip overlay.

Defaults to @“30”.

Declared In

APSVASTSkipButtonConfiguration.h

padding

@property (nonatomic) int padding
Discussion

The internal padding that the skip overlay should apply to its content.

Defaults to 5.

Declared In

APSVASTSkipButtonConfiguration.h

position

@property (nonatomic) APSMediaOverlayPosition position
Discussion

The position of the skip ad overlay, relative to the player surface.

See APSMediaOverlayPosition for possible values. Defaults to kAPSMediaOverlayPositionBottomRight.

Declared In

APSVASTSkipButtonConfiguration.h

progressCircleColor

@property (nonatomic) NSString *progressCircleColor
Discussion

Defines the color of the progress bar indicating the elapsed time since ad has started.

Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor lightGrayColor].

Declared In

APSVASTSkipButtonConfiguration.h

progressCircleTextColor

@property (nonatomic) NSString *progressCircleTextColor
Discussion

Defines the color of the text in the middle of the progress circle, indicating the number of seconds left until skip activation.

Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor clearColor].

Declared In

APSVASTSkipButtonConfiguration.h

progressCircleTrackColor

@property (nonatomic) NSString *progressCircleTrackColor
Discussion

Defines the color of the progress bar indicating the total duration of the ad.

Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor darkGrayColor].

Declared In

APSVASTSkipButtonConfiguration.h

progressPosition

@property (nonatomic) APSSkipOverlayProgressPosition progressPosition
Discussion

Defines where inside the skip overlay should the progress circle be rendered.

See APSSkipOverlayProgressPosition for more details. Defaults to kAPSSkipOverlayProgressPositionRight.

Declared In

APSVASTSkipButtonConfiguration.h

text

@property (nonatomic) NSString *text
Discussion

The text that should be displayed in the skip button.

Defaults to “Skip”.

Declared In

APSVASTSkipButtonConfiguration.h

textColor

@property (nonatomic) NSString *textColor
Discussion

The color of the text diplayed in the skip button.

Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor whiteColor].

Declared In

APSVASTSkipButtonConfiguration.h

width

@property (nonatomic) NSString *width
Discussion

The width of the skip overlay.

Defaults to @“75”.

Declared In

APSVASTSkipButtonConfiguration.h

CocoaDocs.org - APSVASTSkipOverlayController Class Reference

VeesoPlayer2.0.28

Inherits from APSMediaPlayerOverlayController : UIViewController
Declared in APSVASTSkipOverlayController.h
CocoaDocs.org - KRHub Class Reference

VeesoPlayer2.0.28

Inherits from NSObject
Declared in KRHub.h

Overview

A KRHub object can easily become a container of references to other objects or classes, organized in groups. To be able to register themselves with a KRHub, objects must implement the KRAdapter protocol. Within a single group there can not be more objects that declare the same type.

Tasks
  • – adaptersForGroup:

    Returns the list of available registered objects for a specified group.
  • – registerAdapter:

    Registers a new adapter to the default group.
  • – adapterForType:

    Returns an object of the specified type, if such an object is currently registered in the default group.
  • – registerAdapter:inGroup:

    Registeres a new adapter to a specific group
  • – adapterForType:inGroup:

    Returns an object of the specified type, if such an object is currently registered in the specified group.
  • – registerClass:inGroup:

    Registers a class to a specific group and a specific type. Upon requesting a new object from this group and type, a new object of the registered class will be instantiated and returned.
  • – registerClass:

    Registers a class to the default group, under a specific type. Upon requesting a new object from this type from the default group, a new object of the registered class will be instantiated and returned.

Instance Methods

adapterForType:

- (NSObject<KRAdapter> *)adapterForType:(NSString *)type
Discussion

Returns an object of the specified type, if such an object is currently registered in the default group.

Parameters

type

The required object type.

Return Value

An object if any is registered, nil otherwise.

Declared In

KRHub.h

adapterForType:inGroup:

- (NSObject<KRAdapter> *)adapterForType:(NSString *)type inGroup:(NSString *)group
Discussion

Returns an object of the specified type, if such an object is currently registered in the specified group.

Parameters

type

The required object type.

group

The required group.

Return Value

An object if any is registered, nil otherwise.

Declared In

KRHub.h

adaptersForGroup:

- (NSMutableDictionary *)adaptersForGroup:(NSString *)group
Discussion

Returns the list of available registered objects for a specified group.

Parameters

group

The required group.

Return Value

A dictionary containing all objects registered for the required group. The dictionary keys are the types, as specified by the objects.

Declared In

KRHub.h

registerAdapter:

- (void)registerAdapter:(NSObject<KRAdapter> *)adapter
Discussion

Registers a new adapter to the default group.

Parameters

adapter

The adapter to be registered. The object needs to implement KRAdapter.

Declared In

KRHub.h

registerAdapter:inGroup:

- (void)registerAdapter:(NSObject<KRAdapter> *)adapter inGroup:(NSString *)group
Discussion

Registeres a new adapter to a specific group

Parameters

adapter

The adapter to be registered. The object needs to implement KRAdapter.

group

The group to register the adapter into.

Declared In

KRHub.h

registerClass:

- (void)registerClass:(Class)cclass
Discussion

Registers a class to the default group, under a specific type. Upon requesting a new object from this type from the default group, a new object of the registered class will be instantiated and returned.

Parameters

cclass

The class to register

Declared In

KRHub.h

registerClass:inGroup:

- (void)registerClass:(Class)cclass inGroup:(NSString *)group
Discussion

Registers a class to a specific group and a specific type. Upon requesting a new object from this group and type, a new object of the registered class will be instantiated and returned.

Parameters

cclass

The class to register.

group

The group to register the call into.

Declared In

KRHub.h

CocoaDocs.org - APSAVPlayerSeekStatus Constants Reference

VeesoPlayer2.0.28

Declared in APSMediaPlayerProtocol.h

APSAVPlayerSeekStatus

Definition

typedef NS_ENUM(NSInteger, APSAVPlayerSeekStatus ) {
   APSAVPlayerSeekStatusNoSeeking,
   APSAVPlayerSeekStatusBackward,
   APSAVPlayerSeekStatusForward,
};

Constants

APSAVPlayerSeekStatusNoSeeking

APSMediaPlayerProtocol.h.

APSAVPlayerSeekStatusBackward

APSMediaPlayerProtocol.h.

APSAVPlayerSeekStatusForward

APSMediaPlayerProtocol.h.

CocoaDocs.org - APSAdPodFallback Constants Reference

VeesoPlayer2.0.28

Declared in APSVASTAdBreak.h

APSAdPodFallback

VAST 3.0 defines Ad Pods, with fallback mechanisms that allow loading an ad buffet of commercials to playback if the main ads fail. This value specifies how to treat backwards compatibility issues with VAST 2.0 and 1.0, by choosing what ads are promoted to the main Ad Pod if no valid Pods are detected.

Definition

typedef NS_ENUM(NSInteger, APSAdPodFallback ) {
   APSAdPodFallbackSelectAll,
   APSAdPodFallbackSelectFirst,
   APSAdPodFallbackDrop,
};

Constants

APSAdPodFallbackSelectAll

Load all retrieved ads if no valid Ad Pods are found.

APSVASTAdBreak.h.

APSAdPodFallbackSelectFirst

Load only the first retrieved ad if no valid Ad Pods are found.

APSVASTAdBreak.h.

APSAdPodFallbackDrop

Drop the whole ad request if no valid Ad Pods are found. This value will disable VAST 1.0 and 2.0 compatibility.

APSVASTAdBreak.h.

Declared In

APSVASTAdBreak.h
CocoaDocs.org - APSBackendPlayer Constants Reference

VeesoPlayer2.0.28

Declared in APSMediaPlayer.h

APSBackendPlayer

Definition

typedef NS_ENUM(NSInteger, APSBackendPlayer ) {
   APSBackendAVPlayer,
   APSBackendMPMoviePlayer,
   APSBackendChromecastPlayer,
   APSBackendCustomPlayer,
};

Constants

APSBackendAVPlayer

APSMediaPlayer.h.

APSBackendMPMoviePlayer

APSMediaPlayer.h.

APSBackendChromecastPlayer

APSMediaPlayer.h.

APSBackendCustomPlayer

APSMediaPlayer.h.

CocoaDocs.org - APSControlsOverlayComponents Constants Reference

VeesoPlayer2.0.28

Declared in APSMediaPlayerControlsOverlayController.h

APSControlsOverlayComponents

Controls bar components.

Definition

typedef NS_OPTIONS(NSUInteger, APSControlsOverlayComponents ) {
   APSCurrentTimeControl = 1 < < 0,
   APSTimeSliderControl = 1 < < 1,
   APSTotalTimeControl = 1 < < 2,
   APSAirPlayControl = 1 < < 3,
   APSChromecastControl = 1 < < 4,
   APSFullScreenControl = 1 < < 5,
   APSThumbnailTimeSliderControl = 1 < < 6,
   APSPreviousControl = 1 < < 7,
   APSNextControl = 1 < < 8,
   APSPlaybackControl = 1 < < 9,
   APSAdMarksControl = 1 < < 10,
};

Constants

APSCurrentTimeControl

The current playback time counter.

APSMediaPlayerControlsOverlayController.h.

APSTimeSliderControl

The seek bar (time slider) control.

APSMediaPlayerControlsOverlayController.h.

APSTotalTimeControl

The total playback time display.

APSMediaPlayerControlsOverlayController.h.

APSAirPlayControl

The AirPlay video control. This control only appears when an AirPlay ready device is detected in the current network.

APSMediaPlayerControlsOverlayController.h.

APSChromecastControl

The Chromecast video control. This control only appears when a Chromecast ready device is detected in the current network.

APSMediaPlayerControlsOverlayController.h.

APSFullScreenControl

The fullscreen toggle control.

APSMediaPlayerControlsOverlayController.h.

APSThumbnailTimeSliderControl

The seek bar (time slider) control, with mid-seek thumbnail support.

APSMediaPlayerControlsOverlayController.h.

APSPreviousControl

Control allowing the user to return to previous unit in the playlist.

APSMediaPlayerControlsOverlayController.h.

APSNextControl

Control allowing the user to proceed to the next unit in the playlist.

APSMediaPlayerControlsOverlayController.h.

APSPlaybackControl

The play/stop control.

APSMediaPlayerControlsOverlayController.h.

APSAdMarksControl

The ad marks

APSMediaPlayerControlsOverlayController.h.

Declared In

APSMediaPlayerControlsOverlayController.h
CocoaDocs.org - APSHandleSeekEvent Constants Reference

VeesoPlayer2.0.28

Declared in APSMediaUnit.h

APSHandleSeekEvent

Specifies how the unit should handle seeking through multiple ad breaks.

Definition

typedef NS_ENUM(NSInteger, APSHandleSeekEvent ) {
   APSHandleSeekEventPlayFirstBreak,
   APSHandleSeekEventPlayLastBreak,
   APSHandleSeekEventPlayAllBreaks,
};

Constants

APSHandleSeekEventPlayFirstBreak

This will only trigger the first ad break.

APSMediaUnit.h.

APSHandleSeekEventPlayLastBreak

This will only trigger the last ad break.

APSMediaUnit.h.

APSHandleSeekEventPlayAllBreaks

This will trigger all ad breaks.

APSMediaUnit.h.

Declared In

APSMediaUnit.h
CocoaDocs.org - APSMediaControlsDisplay Constants Reference

VeesoPlayer2.0.28

Declared in APSMediaUnit.h

APSMediaControlsDisplay

Specifies how the controls bar should be displayed for a media unit.

Definition

typedef NS_ENUM(NSInteger, APSMediaControlsDisplay ) {
   APSMediaControlsDisplayBottom,
   APSMediaControlsDisplayTop,
   APSMediaControlsDisplayNone,
};

Constants

APSMediaControlsDisplayBottom

The controls bar should be displayed at the bottom of the player surface.

APSMediaUnit.h.

APSMediaControlsDisplayTop

The controls bar should be displayed at the top of the player surface.

APSMediaUnit.h.

APSMediaControlsDisplayNone

The controls bar should not be displayed for this unit.

APSMediaUnit.h.

Declared In

APSMediaUnit.h
CocoaDocs.org - APSMediaEventState Constants Reference

VeesoPlayer2.0.28

Declared in APSMediaEvent.h

APSMediaEventState

Describes the current lifecycle state of a APSMediaEvent.

Definition

typedef NS_ENUM(NSInteger, APSMediaEventState ) {
   APSMediaEventStateUnloaded,
   APSMediaEventStatePreloading,
   APSMediaEventStatePreloaded,
   APSMediaEventStateFailed,
   APSMediaEventStateTriggered,
   APSMediaEventStateFinished,
};

Constants

APSMediaEventStateUnloaded

The event has not yet been loaded.

APSMediaEvent.h.

APSMediaEventStatePreloading

The event is currently preloading.

APSMediaEvent.h.

APSMediaEventStatePreloaded

The event has succesfully preloaded and is ready to be triggered.

APSMediaEvent.h.

APSMediaEventStateFailed

The event failed to preload and should not be triggered.

APSMediaEvent.h.

APSMediaEventStateTriggered

The event is triggered.

APSMediaEvent.h.

APSMediaEventStateFinished

The event finished.

APSMediaEvent.h.

Declared In

APSMediaEvent.h
CocoaDocs.org - APSMediaOverlayPosition Constants Reference

VeesoPlayer2.0.28

Declared in APSMediaOverlay.h

APSMediaOverlayPosition

Describes the position the overlay should take when placed on-screen by the player.

Definition

typedef NS_ENUM(NSInteger, APSMediaOverlayPosition ) {
   kAPSMediaOverlayPositionFullscreen,
   kAPSMediaOverlayPositionBottomLeft,
   kAPSMediaOverlayPositionBottomRight,
   kAPSMediaOverlayPositionTopLeft,
   kAPSMediaOverlayPositionTopRight,
   kAPSMediaOverlayPositionTop,
   kAPSMediaOverlayPositionBottom,
   kAPSMediaOverlayPositionLeft,
   kAPSMediaOverlayPositionRight,
   kAPSMediaOverlayPositionUnspecified,
};

Constants

kAPSMediaOverlayPositionFullscreen

The overlay should be stretched to fit the whole player surface.

APSMediaOverlay.h.

kAPSMediaOverlayPositionBottomLeft

The overlay should be bottom-left aligned with the player surface.

APSMediaOverlay.h.

kAPSMediaOverlayPositionBottomRight

The overlay should be bottom-right aligned with the player surface.

APSMediaOverlay.h.

kAPSMediaOverlayPositionTopLeft

The overlay should be top-left aligned with the player surface.

APSMediaOverlay.h.

kAPSMediaOverlayPositionTopRight

The overlay should be top-right aligned with the player surface.

APSMediaOverlay.h.

kAPSMediaOverlayPositionTop

The overlay should be placed centrally in the top of the player surface.

APSMediaOverlay.h.

kAPSMediaOverlayPositionBottom

The overlay should be placed centrally at the bottom of the player surface.

APSMediaOverlay.h.

kAPSMediaOverlayPositionLeft

The overlay should be vertically centered to the left of the player surface.

APSMediaOverlay.h.

kAPSMediaOverlayPositionRight

The overlay should be vertically centered to the right of the player surface.

APSMediaOverlay.h.

kAPSMediaOverlayPositionUnspecified

The overlay will not be placed on screen.

APSMediaOverlay.h.

Declared In

APSMediaOverlay.h
CocoaDocs.org - APSMoviePlayerSourceType Constants Reference

VeesoPlayer2.0.28

Declared in APSMediaPlayerProtocol.h

APSMoviePlayerSourceType

Definition

typedef NS_ENUM(NSInteger, APSMoviePlayerSourceType ) {
   APSMoviePlayerSourceTypeOnDemand,
   APSMoviePlayerSourceTypeLive,
};

Constants

APSMoviePlayerSourceTypeOnDemand

APSMediaPlayerProtocol.h.

APSMoviePlayerSourceTypeLive

APSMediaPlayerProtocol.h.

CocoaDocs.org - APSResolvMultipleAdsConflictsBy Constants Reference

VeesoPlayer2.0.28

Declared in APSVASTAdBreak.h

APSResolvMultipleAdsConflictsBy

The VMAP standard permits allowing only one ad from a certain ad source. This constant defines how the VAST builder plugin deals with situations when multiple valid ads are retrieved from a source that is disallowed to load several ads at one time.

Definition

typedef NS_ENUM(NSInteger, APSResolvMultipleAdsConflictsBy ) {
   APSResolvMultipleAdsConflictsByDropping,
   APSResolvMultipleAdsConflictsBySelectingFirst,
   APSResolvMultipleAdsConflictsBySelectingRandom,
};

Constants

APSResolvMultipleAdsConflictsByDropping

Solve the issue by dropping all loaded ads.

APSVASTAdBreak.h.

APSResolvMultipleAdsConflictsBySelectingFirst

Solve the issue by only inserting the first valid ad retrieved, honoring the defined order in the VAST.

APSVASTAdBreak.h.

APSResolvMultipleAdsConflictsBySelectingRandom

Solve the issue by only inserting one random ad from the loaded batch.

APSVASTAdBreak.h.

Declared In

APSVASTAdBreak.h
CocoaDocs.org - APSSkipOverlayProgressPosition Constants Reference

VeesoPlayer2.0.28

Declared in APSVASTSkipOverlayController.h

APSSkipOverlayProgressPosition

Defines where inside the skip overlay should the progress circle be rendered.

Definition

typedef NS_ENUM(NSInteger, APSSkipOverlayProgressPosition ) {
   kAPSSkipOverlayProgressPositionLeft,
   kAPSSkipOverlayProgressPositionRight,
   kAPSSkipOverlayProgressPositionHidden,
};

Constants

kAPSSkipOverlayProgressPositionLeft

Render the progress circle in the left side of the skip overlay.

APSVASTSkipOverlayController.h.

kAPSSkipOverlayProgressPositionRight

Render the progress circle in the right side of the skip overlay.

APSVASTSkipOverlayController.h.

kAPSSkipOverlayProgressPositionHidden

Do not render the progress circle.

APSVASTSkipOverlayController.h.

Declared In

APSVASTSkipOverlayController.h
CocoaDocs.org - APSVASTAdBreakType Constants Reference

VeesoPlayer2.0.28

Declared in APSVASTAdBreak.h

APSVASTAdBreakType

Defines how an APSVASTAdBreak should be placed relative to the main content units.

Definition

typedef NS_ENUM(NSInteger, APSVASTAdBreakType ) {
   APSVASTPreContent,
   APSVASTPostContent,
   APSVASTMidContent,
   APSVASTNonLinear,
};

Constants

APSVASTPreContent

Place the APSMediaUnits corresponding to the ad break at the beginning of the main content units.

APSVASTAdBreak.h.

APSVASTPostContent

Place the APSMediaUnits corresponding to the ad break at the end of the main content units.

APSVASTAdBreak.h.

APSVASTMidContent

Place the APSMediaUnits corresponding to the ad break in the middle of each main content unit, at a defined offset (see the adOffset property of APSVASTAdBreak).

APSVASTAdBreak.h.

APSVASTNonLinear

Place the APSMediaOverlays corresponding to the ad break in the middle of each main content unit, ad a defined offset (see the adOffset property of APSVASTAdBreak).

APSVASTAdBreak.h.

Declared In

APSVASTAdBreak.h
CocoaDocs.org - APSWebviewDismissedAction Constants Reference

VeesoPlayer2.0.28

Declared in APSMediaPlayerOverlayController.h

APSWebviewDismissedAction

Defines the action that the player should take when resuming playback after an interruption caused by user interaction, that determined the display of the in-app web browser.

Definition

typedef NS_ENUM(NSInteger, APSWebviewDismissedAction ) {
   APSHideOverlayOnWebviewDismiss,
   APSSkipUnitOnWebviewDismiss,
   APSDoNothingOnWebviewDismiss,
};

Constants

APSHideOverlayOnWebviewDismiss

Player should hide the calling overlay on webview dismiss.

APSMediaPlayerOverlayController.h.

APSSkipUnitOnWebviewDismiss

Player should skip the current unit on webview dismiss.

APSMediaPlayerOverlayController.h.

APSDoNothingOnWebviewDismiss

No action should be taken on webview dismiss.

APSMediaPlayerOverlayController.h.

Declared In

APSMediaPlayerOverlayController.h
CocoaDocs.org - APSMediaBuilderPlugin Protocol Reference

VeesoPlayer2.0.28

Conforms to KRAdapter
Declared in APSMediaBuilderPlugin.h

Overview

Defines methods that need to be implemented by any object that want to register as an APSMediaBuilder plugin.

Tasks

Plugin Execution

Plugin Dictionary Configuration

  • – dictionaryConfigurationKey

    The string key that will be used in the root of JSON and dictionary builder configurations to hold all the specific configuration details for the plugin.

         required method
  • – configureFromDictionary:

    This method is called by the APSMediaBuilder object, in the process of its configuration. The method is only called if in the root of the configuring JSON or NSDictionary there is a key equal to the string defined by the plugin using the dictionaryConfigurationKey method.

         required method

Instance Methods

configureFromDictionary:

- (void)configureFromDictionary:(NSDictionary *)configuration
Discussion

This method is called by the APSMediaBuilder object, in the process of its configuration. The method is only called if in the root of the configuring JSON or NSDictionary there is a key equal to the string defined by the plugin using the dictionaryConfigurationKey method.

Parameters

configuration

A NSDictionary object containing the specific plugin configuration data.

Declared In

APSMediaBuilderPlugin.h

dictionaryConfigurationKey

- (NSString *)dictionaryConfigurationKey
Discussion

The string key that will be used in the root of JSON and dictionary builder configurations to hold all the specific configuration details for the plugin.

Return Value

String key.

Declared In

APSMediaBuilderPlugin.h

startForBuilder:

- (void)startForBuilder:(APSMediaBuilder *)builder
Discussion

This method will be called at the beginning of the mediaUnits method of the APSMediaBuilder object that registered the plugin.

Parameters

builder

A reference to the calling APSMediaBuilder object.

Declared In

APSMediaBuilderPlugin.h

CocoaDocs.org - APSMediaEventProtocol Protocol Reference

VeesoPlayer2.0.28

Conforms to NSObject
Declared in APSMediaEvent.h

Overview

The APSMediaEventProtocol protocol describes methods that objects extending the associated APSMediaEvent class must or can implement.

Tasks
  • – onTrigger

    This code will be executed once the event is triggered by the player.

         required method
  • – onPreload

    This method will be invoked on a different thread by the player, before the event start point, as set by the [APSMediaEvent preTriggerInterval] property.
  • – onUpdate

    This method will be invoked by the player periodically, giving the event the opportunity to respond to updated playback information.
  • – onUnload

    This method will be invoked by the player once the event has reached the end point and will be deallocated.

Instance Methods

onPreload

- (void)onPreload
Discussion

This method will be invoked on a different thread by the player, before the event start point, as set by the [APSMediaEvent preTriggerInterval] property.

Declared In

APSMediaEvent.h

onTrigger

- (void)onTrigger
Discussion

This code will be executed once the event is triggered by the player.

Declared In

APSMediaEvent.h

onUnload

- (void)onUnload
Discussion

This method will be invoked by the player once the event has reached the end point and will be deallocated.

Declared In

APSMediaEvent.h

onUpdate

- (void)onUpdate
Discussion

This method will be invoked by the player periodically, giving the event the opportunity to respond to updated playback information.

Declared In

APSMediaEvent.h

CocoaDocs.org - APSMediaPlayerActionDelegate Protocol Reference

VeesoPlayer2.0.28

Conforms to NSObject
Declared in APSMediaPlayer.h

Overview

The APSMediaPlayerActionDelegate protocol declares the two methods that a class must implement in order to become an APSMediaPlayer actionDelegate. The object implementing APSMediaPlayer will receive information about the URLs that need to be executed as the user interacts with the player.

Tasks
  • – canRespondTo:

    Returns a Boolean value indicating whether the receiver is able to interpret and react to the given input NSURL.

         required method
  • – respondTo:

    If the APSMediaPlayerActionDelegate implementing object returns YES from the canRespondTo method for a certain URL, this method will be triggered to request effective execution.

         required method

Instance Methods

canRespondTo:

- (BOOL)canRespondTo:(NSURL *)url
Discussion

Returns a Boolean value indicating whether the receiver is able to interpret and react to the given input NSURL.

Parameters

url

The URL that needs to be launched.

Return Value

YES if the object can interpret and react to the given input URL, NO otherwise.

Declared In

APSMediaPlayer.h

respondTo:

- (void)respondTo:(NSURL *)url
Discussion

If the APSMediaPlayerActionDelegate implementing object returns YES from the canRespondTo method for a certain URL, this method will be triggered to request effective execution.

Parameters

url

The URL that needs to be launched.

Declared In

APSMediaPlayer.h

CocoaDocs.org - APSMediaPlayerOverlayControllerProtocol Protocol Reference

VeesoPlayer2.0.28

Conforms to KRAdapter
Declared in APSMediaPlayerOverlayController.h

Overview

The APSMediaPlayerOverlayController defines all the methods that a UIViewController subclass must or can implement to be able to register as an overlay controller with the player. This protocol extends the KRAdapter protocol, so objects should also define a unique string type to register under.

Tasks

Overlay Initialization

  • – load

    This method is invoked by the player when first diplaying the overlay controller object.

         required method
  • – preload

    This method is invoked by the player on a background thread, before the overlay start point, as set by the [APSMediaEvent preTriggerInterval] property.

Callbacks

  • – update

    This method is called whenever the playback state of the player is changed (e.g. current playback time changes, playback state changes etc.). If the overlay controller needs to update its interface as a result of these changes, the updates should be performed in this method.
  • – overlayWillBeRemoved

    This method is invoked by the player, before the overlay controller’s view is removed from the player surface. Any overlay cleanup code should be performed in this method.
  • – didEnterFullscreen

    This method is invoked by the player, when fullscreen mode is enabled.
  • – didExitFullscreen

    This method is invoked by the player, when fullscreen mode is disabled.

Handling Playback

  • – currentPlaybackTime

    Allows an overlay controller to return a current playback time in place of the parent APSMediaUnit object, if the url property of that object is nil.
  • – playableDuration

    Allows an overlay controller to return a total playable (buffered) time in place of the parent APSMediaUnit object, if the url property of that object is nil.
  • – setCurrentPlaybackTime:

    Allows an overlay that handles media playback in place of the parent unit to internally set the current playback time.
  • – duration

    Allows an overlay controller to return a total playback duration in place of the parent APSMediaUnit object, if the url property of that object is nil.
  • – playbackState

    Allows an overlay controller to return a playback state in place of the parent APSMediaUnit object, if the url property of that object is nil. See Apple’s documentation for more details about MPMoviePlaybackState.
  • – loadState

    Allows an overlay controller to return a load state in place of the parent APSMediaUnit object, if the url property of that object is nil. See Apple’s documentation for more details about MPMovieLoadState.
  • – movieSourceType

    Allows an overlay controller to return a media source type in place of the parent APSMediaUnit object, if the url property of that object is nil. See Apple’s documentation for more details about MPMovieSourceType.
  • – play

    Allows an overlay that handles media playback in place of the parent unit to start playback.
  • – stop

    Allows an overlay that handles media playback in place of the parent unit to stop playback.
  • – pause

    Allows an overlay that handles media playback in place of the parent unit to pause playback.
  • – thumbnailImageAtTime:

    Allows an overlay that handles media playback in place of the parent unit to return a thumbnail image at a specific time interval from the managed video.

Defining Behavior for Webview Dismiss Events

  • – onWebviewDismiss

    Allows an overlay controller to specify what action the player should take when it comes back into focus, after a modal in-app web browser was triggered and dismissed by user interaction.

Instance Methods

currentPlaybackTime

- (NSTimeInterval)currentPlaybackTime
Discussion

Allows an overlay controller to return a current playback time in place of the parent APSMediaUnit object, if the url property of that object is nil.

This occurs for overlays that handle media playback in place of the parent unit, for e.g. the Youtube player overlay controller. * * @return The current overlay-managed playback time, in seconds.

Declared In

APSMediaPlayerOverlayController.h

didEnterFullscreen

- (void)didEnterFullscreen
Discussion

This method is invoked by the player, when fullscreen mode is enabled.

Declared In

APSMediaPlayerOverlayController.h

didExitFullscreen

- (void)didExitFullscreen
Discussion

This method is invoked by the player, when fullscreen mode is disabled.

Declared In

APSMediaPlayerOverlayController.h

duration

- (NSTimeInterval)duration
Discussion

Allows an overlay controller to return a total playback duration in place of the parent APSMediaUnit object, if the url property of that object is nil.

This occurs for overlays that handle media playback in place of the parent unit, for e.g. the Youtube player overlay controller. * * @param playbackTime The total overlay-managed playback duration, in seconds.

Declared In

APSMediaPlayerOverlayController.h

load

- (void)load
Discussion

This method is invoked by the player when first diplaying the overlay controller object.

Declared In

APSMediaPlayerOverlayController.h

loadState

- (MPMovieLoadState)loadState
Discussion

Allows an overlay controller to return a load state in place of the parent APSMediaUnit object, if the url property of that object is nil. See Apple’s documentation for more details about MPMovieLoadState.

This occurs for overlays that handle media playback in place of the parent unit, for e.g. the Youtube player overlay controller. * * @return The current overlay-managed load state.

Declared In

APSMediaPlayerOverlayController.h

movieSourceType

- (MPMovieSourceType)movieSourceType
Discussion

Allows an overlay controller to return a media source type in place of the parent APSMediaUnit object, if the url property of that object is nil. See Apple’s documentation for more details about MPMovieSourceType.

This occurs for overlays that handle media playback in place of the parent unit, for e.g. the Youtube player overlay controller. * * @return The current overlay-managed media source type.

Declared In

APSMediaPlayerOverlayController.h

onWebviewDismiss

- (APSWebviewDismissedAction)onWebviewDismiss
Discussion

Allows an overlay controller to specify what action the player should take when it comes back into focus, after a modal in-app web browser was triggered and dismissed by user interaction.

Return Value

The desired action. See APSWebviewDismissedAction for more details.

Declared In

APSMediaPlayerOverlayController.h

overlayWillBeRemoved

- (void)overlayWillBeRemoved
Discussion

This method is invoked by the player, before the overlay controller’s view is removed from the player surface. Any overlay cleanup code should be performed in this method.

The method is invoked on the main application thread.

Declared In

APSMediaPlayerOverlayController.h

pause

- (void)pause
Discussion

Allows an overlay that handles media playback in place of the parent unit to pause playback.

Declared In

APSMediaPlayerOverlayController.h

play

- (void)play
Discussion

Allows an overlay that handles media playback in place of the parent unit to start playback.

Declared In

APSMediaPlayerOverlayController.h

playableDuration

- (NSTimeInterval)playableDuration
Discussion

Allows an overlay controller to return a total playable (buffered) time in place of the parent APSMediaUnit object, if the url property of that object is nil.

This occurs for overlays that handle media playback in place of the parent unit, for e.g. the Youtube player overlay controller. * * @return The current overlay-managed total playable (buffered) time, in seconds.

Declared In

APSMediaPlayerOverlayController.h

playbackState

- (MPMoviePlaybackState)playbackState
Discussion

Allows an overlay controller to return a playback state in place of the parent APSMediaUnit object, if the url property of that object is nil. See Apple’s documentation for more details about MPMoviePlaybackState.

This occurs for overlays that handle media playback in place of the parent unit, for e.g. the Youtube player overlay controller. * * @return The current overlay-managed playback state.

Declared In

APSMediaPlayerOverlayController.h

preload

- (void)preload
Discussion

This method is invoked by the player on a background thread, before the overlay start point, as set by the [APSMediaEvent preTriggerInterval] property.

Declared In

APSMediaPlayerOverlayController.h

setCurrentPlaybackTime:

- (void)setCurrentPlaybackTime:(NSTimeInterval)playbackTime
Discussion

Allows an overlay that handles media playback in place of the parent unit to internally set the current playback time.

Parameters

playbackTime

The required playback time to seek to, in seconds.

Declared In

APSMediaPlayerOverlayController.h

stop

- (void)stop
Discussion

Allows an overlay that handles media playback in place of the parent unit to stop playback.

Declared In

APSMediaPlayerOverlayController.h

thumbnailImageAtTime:

- (UIImage *)thumbnailImageAtTime:(NSTimeInterval)time
Discussion

Allows an overlay that handles media playback in place of the parent unit to return a thumbnail image at a specific time interval from the managed video.

Parameters

time

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

Return Value

The resulting thumbnail.

Declared In

APSMediaPlayerOverlayController.h

update

- (void)update
Discussion

This method is called whenever the playback state of the player is changed (e.g. current playback time changes, playback state changes etc.). If the overlay controller needs to update its interface as a result of these changes, the updates should be performed in this method.

The method is invoked on the main application thread.

Declared In

APSMediaPlayerOverlayController.h

CocoaDocs.org - APSMediaPlayerProtocol Protocol Reference

VeesoPlayer2.0.28

Conforms to NSObject
Declared in APSMediaPlayerProtocol.h

Tasks

Accessing the APSAVPlayer's view

  •   view

    The container UIView of the player.

         property required method

Properties

  •   isPreparedToPlay

    Returns a Boolean value specifing if the player is ready to play media

         property required method
  •   initialPlaybackTime

    Get or set the initial time in stream from which the player will start playing the media

         property required method
  •   currentPlaybackTime

    Get or set the current position in stream

         property required method
  •   playableDuration

    Get the duration of the buffered content

         property required method
  •   duration

    Get the total duration of the video

         property required method
  •   currentPlaybackRate

    Get or set the current playback rate

         property required method
  •   contentURL

    Get or set the current media’s URL

         property required method
  •   scalingMode

    Get or set the scaling mode of the video according to its viewport

         property required method
  •   shouldAutoplay

    Get or set if the player should autoplay an URL as soon as it is provided

         property required method
  •   playbackState

    Get the current playback state

         property required method
  •   loadState

    Get the current state of the buffer

         property required method
  •   movieSourceType

    Get the current media’s source type (e.g. file or stream)

         property required method
  •   controlStyle

    Set or get how the player controls will appear

         property required method
  •   timedMetadata

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

         property required method
  •   allowsAirPlay

    Specifies whether the movie player allows AirPlay movie playback.

         property required method
  •   airPlayVideoActive

    Check out if AirPlay video is started or stopped.

         property required method

Required protocol methods

Optional protocol methods

Properties

airPlayVideoActive

@property (nonatomic, readonly) BOOL airPlayVideoActive
Discussion

Check out if AirPlay video is started or stopped.

Declared In

APSMediaPlayerProtocol.h

allowsAirPlay

@property (nonatomic) BOOL allowsAirPlay
Discussion

Specifies whether the movie player allows AirPlay movie playback.

Declared In

APSMediaPlayerProtocol.h

contentURL

@property (nonatomic, strong) NSURL *contentURL
Discussion

Get or set the current media’s URL

Declared In

APSMediaPlayerProtocol.h

controlStyle

@property (nonatomic) MPMovieControlStyle controlStyle
Discussion

Set or get how the player controls will appear

Declared In

APSMediaPlayerProtocol.h

currentPlaybackRate

@property (nonatomic) float currentPlaybackRate
Discussion

Get or set the current playback rate

Declared In

APSMediaPlayerProtocol.h

currentPlaybackTime

@property (nonatomic) NSTimeInterval currentPlaybackTime
Discussion

Get or set the current position in stream

Declared In

APSMediaPlayerProtocol.h

duration

@property (nonatomic, readonly) NSTimeInterval duration
Discussion

Get the total duration of the video

Declared In

APSMediaPlayerProtocol.h

initialPlaybackTime

@property (nonatomic) NSTimeInterval initialPlaybackTime
Discussion

Get or set the initial time in stream from which the player will start playing the media

Declared In

APSMediaPlayerProtocol.h

isPreparedToPlay

@property (nonatomic, readonly) BOOL isPreparedToPlay
Discussion

Returns a Boolean value specifing if the player is ready to play media

Declared In

APSMediaPlayerProtocol.h

loadState

@property (nonatomic, readonly) MPMovieLoadState loadState
Discussion

Get the current state of the buffer

Declared In

APSMediaPlayerProtocol.h

movieSourceType

@property (nonatomic) MPMovieSourceType movieSourceType
Discussion

Get the current media’s source type (e.g. file or stream)

Declared In

APSMediaPlayerProtocol.h

playableDuration

@property (nonatomic, readonly) NSTimeInterval playableDuration
Discussion

Get the duration of the buffered content

Declared In

APSMediaPlayerProtocol.h

playbackState

@property (nonatomic, readonly) MPMoviePlaybackState playbackState
Discussion

Get the current playback state

Declared In

APSMediaPlayerProtocol.h

scalingMode

@property (nonatomic) MPMovieScalingMode scalingMode
Discussion

Get or set the scaling mode of the video according to its viewport

Declared In

APSMediaPlayerProtocol.h

shouldAutoplay

@property (nonatomic) BOOL shouldAutoplay
Discussion

Get or set if the player should autoplay an URL as soon as it is provided

Declared In

APSMediaPlayerProtocol.h

timedMetadata

@property (nonatomic, readonly) NSArray *timedMetadata
Discussion

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

Returns an array of the most recent MPTimedMetadata objects provided by the media stream.

Declared In

APSMediaPlayerProtocol.h

view

@property (nonatomic, readonly) UIView *view
Discussion

The container UIView of the player.

Declared In

APSMediaPlayerProtocol.h

Class Methods

backendPriority

+ (NSInteger)backendPriority
Discussion

The priority based on which the backend will be selected

Declared In

APSMediaPlayerProtocol.h

Instance Methods

appendURL:

- (void)appendURL:(NSURL *)url
Discussion

Add an URL to the current play queue

Parameters

url

A NSURL instance pointing to the media location

Declared In

APSMediaPlayerProtocol.h

beginSeekingBackward

- (void)beginSeekingBackward
Discussion

Rewind the media

Declared In

APSMediaPlayerProtocol.h

beginSeekingForward

- (void)beginSeekingForward
Discussion

Play the media with an increased playback rate (speed)

Declared In

APSMediaPlayerProtocol.h

endSeeking

- (void)endSeeking
Discussion

Stop the seeking process startd by beginSeekingForward or beginSeekingBackward;

Declared In

APSMediaPlayerProtocol.h

getMute

- (BOOL)getMute
Discussion

Get if the player is muted or no

Return Value

The mute status

Declared In

APSMediaPlayerProtocol.h

getVolume

- (CGFloat)getVolume
Discussion

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

Return Value

The sound volume of the player

Declared In

APSMediaPlayerProtocol.h

initWithURLs:

- (id)initWithURLs:(NSArray *)urls
Discussion

Create a APSAVPlayer instance

Parameters

urls

A NSArray of NSURLs pointing to the media location

Return Value

The APSAVPlayer instance

Declared In

APSMediaPlayerProtocol.h

insertURL:atIndex:

- (void)insertURL:(NSURL *)url atIndex:(NSInteger)index
Discussion

Insert an URL to the current play queue at the given position

Parameters

url

A NSURL instance pointing to the media location

@param index

Declared In

APSMediaPlayerProtocol.h

pause

- (void)pause
Discussion

Pause the current playing media

Declared In

APSMediaPlayerProtocol.h

play

- (void)play
Discussion

Play the current media in the queue

Declared In

APSMediaPlayerProtocol.h

prepareToPlay

- (void)prepareToPlay
Discussion

Prepare to play media. This is also automatically called on play

Declared In

APSMediaPlayerProtocol.h

requestThumbnailImagesAtTimes:timeOption:

- (void)requestThumbnailImagesAtTimes:(NSArray *)playbackTimes timeOption:(MPMovieTimeOption)option
Discussion

Request a thumbnail image

Parameters

playbackTimes

A NSArray of NSTimeInterval, in seconds, when the thumbnail should be taken from the video

option

Precision

Return Value

The thumbnail image

Declared In

APSMediaPlayerProtocol.h

setMute:

- (void)setMute:(BOOL)mute
Discussion

Mute the player

Parameters

mute

BOOL set YES to mute or NO to unmute.

Declared In

APSMediaPlayerProtocol.h

setVolume:

- (void)setVolume:(CGFloat)volume
Discussion

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

Parameters

volume

CGFloat sound volume.

Declared In

APSMediaPlayerProtocol.h

stop

- (void)stop
Discussion

Stop the player, remove all the items from the queue and remove the player’s CALayer from its superlayer

Declared In

APSMediaPlayerProtocol.h

streamSourceType

- (APSMoviePlayerSourceType)streamSourceType
Discussion

Get the stream’s source type. Different by movieSourceType because it returns if the stream is a VOD stream or a live stream.

Return Value

The stream’s type as a APSMoviePlayerSourceType enum

Declared In

APSMediaPlayerProtocol.h

thumbnailAt:

- (UIImage *)thumbnailAt:(NSTimeInterval)playbackTime
Discussion

Request a thumbnail image

Parameters

playbackTime

The time, in seconds, when the thumbnail should be taken from the video

Return Value

The thumbnail image

Declared In

APSMediaPlayerProtocol.h

thumbnailImageAtTime:timeOption:

- (UIImage *)thumbnailImageAtTime:(NSTimeInterval)playbackTime timeOption:(MPMovieTimeOption)option
Discussion

Request a thumbnail image

Parameters

playbackTime

The time, in seconds, when the thumbnail should be taken from the video

option

Precision

Return Value

The thumbnail image

Declared In

APSMediaPlayerProtocol.h

CocoaDocs.org - APSMediaTrackableObject Protocol Reference

VeesoPlayer2.0.28

Conforms to NSObject
Declared in APSMediaTrackableObject.h

Overview

Defines the properties that an object needs to implement to become trackable by the player.

Tasks
  •   trackingURLs

    This dictionary defines all URLs that need to be notified of specific events from the object’s lifecycle. The keys are event constants, as defined in APSMediaPlayer, and the values are NSArrays containing NSURL objects.

         property required method

Properties

trackingURLs

@property (nonatomic) NSMutableDictionary *trackingURLs
Discussion

This dictionary defines all URLs that need to be notified of specific events from the object’s lifecycle. The keys are event constants, as defined in APSMediaPlayer, and the values are NSArrays containing NSURL objects.

Declared In

APSMediaTrackableObject.h

CocoaDocs.org - APSUnitManagerProtocol Protocol Reference

VeesoPlayer2.0.28

Conforms to KRAdapter
NSObject
Declared in APSUnitManagerProtocol.h

Overview

This protocol provides an interface for external objects that implement dynamic playback operations. Use this if you need to generate media URLs using timestamps or for implementing DRM support.

Tasks

Instance Methods

end

- (void)end
Discussion

When an APSMediaUnit ends playback, if it declares requiring a manager that matches the current object’s [KRAdapter type], this method will be invoked.

Declared In

APSUnitManagerProtocol.h

startForUnit:

- (void)startForUnit:(APSMediaUnit *)unit
Discussion

When an APSMediaUnit is loaded by the player, if it declares requiring a manager that matches the current object’s [KRAdapter type], this method will be invoked.

This method should handle playback by calling [APSMediaPlayer setCurrentURL:] to effectively start media playback for a specific URL, or call another relevant method (like [APSMediaPlayer step]) and generate APSMediaPlayerErrorNotification notifications on error.

Parameters

unit

The currently loading unit.

Declared In

APSUnitManagerProtocol.h

CocoaDocs.org - KRAdapter Protocol Reference

VeesoPlayer2.0.28

Conforms to NSObject
Declared in KRAdapter.h

Overview

The KRAdapter protocol allows an object to declare itself as being of a certain type.

Tasks
  • – type

    Returns the adapter type.

         required method

Instance Methods

type

- (NSString *)type
Discussion

Returns the adapter type.

Return Value

An adapter type in string format.

Declared In

KRAdapter.h

CocoaDocs.org - APSMediaPlayerFinishBlock Block Reference

VeesoPlayer2.0.28

Declared in APSMediaPlayer.h
Availability v1.7
CocoaDocs.org - AVPlayer(View) Category Reference

VeesoPlayer2.0.28

Declared in AVPlayer+View.h

Tasks

Properties

view

@property (nonatomic, weak) APSAVPlayerView *view
CocoaDocs.org - APSAVPlayer Class Reference

VeesoPlayer2.0.28

Inherits from NSObject
Conforms to APSMediaPlayerProtocol
KRAdapter
MPMediaPlayback
Declared in APSAVPlayer.h

Tasks

Accessing the APSAVPlayer's view

  •   view

    The container UIView of the player.

         property

Properties

Instance methods

Properties

airPlayVideoActive

@property (nonatomic, readonly) BOOL airPlayVideoActive
Discussion

Check out if AirPlay video is started or stopped.

Declared In

APSAVPlayer.h

allowsAirPlay

@property (nonatomic) BOOL allowsAirPlay
Discussion

Specifies whether the movie player allows AirPlay movie playback.

Declared In

APSAVPlayer.h

contentURL

@property (nonatomic, strong) NSURL *contentURL
Discussion

Get or set the current media’s URL

Declared In

APSAVPlayer.h

controlStyle

@property (nonatomic) MPMovieControlStyle controlStyle
Discussion

Set how the player controls will appear

Declared In

APSAVPlayer.h

currentPlaybackRate

@property (nonatomic) float currentPlaybackRate
Discussion

Get or set the current playback rate

Declared In

APSAVPlayer.h

currentPlaybackTime

@property (nonatomic) NSTimeInterval currentPlaybackTime
Discussion

Get or set the current position in stream

Declared In

APSAVPlayer.h

duration

@property (nonatomic, readonly) NSTimeInterval duration
Discussion

Get the total duration of the video

Declared In

APSAVPlayer.h

initialPlaybackTime

@property (nonatomic) NSTimeInterval initialPlaybackTime
Discussion

Get or set the initial time in stream from which the player will start playing the media

Declared In

APSAVPlayer.h

isPreparedToPlay

@property (nonatomic, readonly) BOOL isPreparedToPlay
Discussion

Returns a Boolean value specifing if the player is ready to play media

Declared In

APSAVPlayer.h

loadState

@property (nonatomic, readonly) MPMovieLoadState loadState
Discussion

Get the current state of the buffer

Declared In

APSAVPlayer.h

movieSourceType

@property (nonatomic) MPMovieSourceType movieSourceType
Discussion

Get the current media’s source type (e.g. file or stream)

Declared In

APSAVPlayer.h

playableDuration

@property (nonatomic, readonly) NSTimeInterval playableDuration
Discussion

Get the duration of the buffered content

Declared In

APSAVPlayer.h

playbackState

@property (nonatomic, readonly) MPMoviePlaybackState playbackState
Discussion

Get the current playback state

Declared In

APSAVPlayer.h

scalingMode

@property (nonatomic) MPMovieScalingMode scalingMode
Discussion

Get or set the scaling mode of the video according to its viewport

Declared In

APSAVPlayer.h

shouldAutoplay

@property (nonatomic) BOOL shouldAutoplay
Discussion

Get or set if the player should autoplay an URL as soon as it is provided

Declared In

APSAVPlayer.h

timedMetadata

@property (nonatomic, readonly) NSArray *timedMetadata
Discussion

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

Returns an array of the most recent MPTimedMetadata objects provided by the media stream.

Declared In

APSAVPlayer.h

view

@property (nonatomic, strong) UIView *view
Discussion

The container UIView of the player.

Declared In

APSAVPlayer.h

Class Methods

backendPriority

+ (NSInteger)backendPriority
Discussion

The priority based on which the backend will be selected

Declared In

APSAVPlayer.h

Instance Methods

appendURL:

- (void)appendURL:(NSURL *)url
Discussion

Add an URL to the current play queue

Parameters

url

A NSURL instance pointing to the media location

Declared In

APSAVPlayer.h

beginSeekingBackward

- (void)beginSeekingBackward
Discussion

Rewind the media

Declared In

APSAVPlayer.h

beginSeekingForward

- (void)beginSeekingForward
Discussion

Play the media with an increased playback rate (speed)

Declared In

APSAVPlayer.h

endSeeking

- (void)endSeeking
Discussion

Stop the seeking process startd by beginSeekingForward or beginSeekingBackward;

Declared In

APSAVPlayer.h

getMute

- (BOOL)getMute
Discussion

Get if the player is muted or no

Return Value

The mute status

Declared In

APSAVPlayer.h

getVolume

- (CGFloat)getVolume
Discussion

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

Return Value

The sound volume of the player

Declared In

APSAVPlayer.h

initWithURLs:

- (id)initWithURLs:(NSArray *)urls
Discussion

Create a APSAVPlayer instance

Parameters

urls

A NSArray of NSURLs pointing to the media location

Return Value

The APSAVPlayer instance

Declared In

APSAVPlayer.h

pause

- (void)pause
Discussion

Pause the current playing media

Declared In

APSAVPlayer.h

play

- (void)play
Discussion

Play the current media in the queue

Declared In

APSAVPlayer.h

prepareToPlay

- (void)prepareToPlay
Discussion

Prepare to play media. This is also automatically called on play

Declared In

APSAVPlayer.h

requestThumbnailImagesAtTimes:timeOption:

- (void)requestThumbnailImagesAtTimes:(NSArray *)playbackTimes timeOption:(MPMovieTimeOption)option
Discussion

Request a thumbnail image

Parameters

playbackTimes

A NSArray of NSTimeInterval, in seconds, when the thumbnail should be taken from the video

option

Precision

Return Value

The thumbnail image

Declared In

APSAVPlayer.h

setMute:

- (void)setMute:(BOOL)mute
Discussion

Mute the player

Parameters

mute

BOOL set YES to mute or NO to unmute.

Declared In

APSAVPlayer.h

setVolume:

- (void)setVolume:(CGFloat)volume
Discussion

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

Parameters

volume

CGFloat sound volume.

Declared In

APSAVPlayer.h

stop

- (void)stop
Discussion

Stop the player, remove all the items from the queue and remove the player’s CALayer from its superlayer

Declared In

APSAVPlayer.h

streamSourceType

- (APSMoviePlayerSourceType)streamSourceType
Discussion

Get the stream’s source type. Different by movieSourceType because it returns if the stream is a VOD stream or a live stream.

Return Value

The stream’s type as a APSMoviePlayerSourceType enum

Declared In

APSAVPlayer.h

thumbnailAt:

- (UIImage *)thumbnailAt:(NSTimeInterval)playbackTime
Discussion

Request a thumbnail image

Parameters

playbackTime

The time, in seconds, when the thumbnail should be taken from the video

Return Value

The thumbnail image

Declared In

APSAVPlayer.h

thumbnailImageAtTime:timeOption:

- (UIImage *)thumbnailImageAtTime:(NSTimeInterval)playbackTime timeOption:(MPMovieTimeOption)option
Discussion

Request a thumbnail image

Parameters

playbackTime

The time, in seconds, when the thumbnail should be taken from the video

option

Precision

Return Value

The thumbnail image

Declared In

APSAVPlayer.h

CocoaDocs.org - APSAVPlayerView Class Reference

VeesoPlayer2.0.28

Inherits from UIView
Declared in APSAVPlayerView.h

Tasks

Setting and getting AVPlayer instance

  • – player

    Get the AVPlayer instance associated with the current view.
  • – setPlayer:

    Set an AVPlayer instance to the current view.

Instance Methods

player

- (AVPlayer *)player
Discussion

Get the AVPlayer instance associated with the current view.

Declared In

APSAVPlayerView.h

setPlayer:

- (void)setPlayer:(AVPlayer *)player
Discussion

Set an AVPlayer instance to the current view.

Parameters

player

An AVPlayer instance

Declared In

APSAVPlayerView.h

CocoaDocs.org - APSChromeCastPlayer Class Reference

VeesoPlayer2.0.28

Inherits from NSObject
Conforms to APSMediaPlayerProtocol
GCKMediaControlChannelDelegate
KRAdapter
Declared in APSChromeCastPlayer.h

Tasks

Accessing the APSAVPlayer's view

  •   view

    The container UIView of the player.

         property

Properties

Instance methods

Properties

airPlayVideoActive

@property (nonatomic, readonly) BOOL airPlayVideoActive
Discussion

Check out if AirPlay video is started or stopped.

Declared In

APSChromeCastPlayer.h

allowsAirPlay

@property (nonatomic) BOOL allowsAirPlay
Discussion

Specifies whether the movie player allows AirPlay movie playback.

Declared In

APSChromeCastPlayer.h

contentURL

@property (nonatomic, strong) NSURL *contentURL
Discussion

Get or set the current media’s URL

Declared In

APSChromeCastPlayer.h

controlStyle

@property (nonatomic) MPMovieControlStyle controlStyle
Discussion

Set how the player controls will appear

Declared In

APSChromeCastPlayer.h

currentPlaybackRate

@property (nonatomic) float currentPlaybackRate
Discussion

Get or set the current playback rate

Declared In

APSChromeCastPlayer.h

currentPlaybackTime

@property (nonatomic) NSTimeInterval currentPlaybackTime
Discussion

Get or set the current position in stream

Declared In

APSChromeCastPlayer.h

duration

@property (nonatomic, readonly) NSTimeInterval duration
Discussion

Get the total duration of the video

Declared In

APSChromeCastPlayer.h

initialPlaybackTime

@property (nonatomic) NSTimeInterval initialPlaybackTime
Discussion

Get or set the initial time in stream from which the player will start playing the media

Declared In

APSChromeCastPlayer.h

isPreparedToPlay

@property (nonatomic, readonly) BOOL isPreparedToPlay
Discussion

Returns a Boolean value specifing if the player is ready to play media

Declared In

APSChromeCastPlayer.h

loadState

@property (nonatomic, readonly) MPMovieLoadState loadState
Discussion

Get the current state of the buffer

Declared In

APSChromeCastPlayer.h

movieSourceType

@property (nonatomic) MPMovieSourceType movieSourceType
Discussion

Get the current media’s source type (e.g. file or stream)

Declared In

APSChromeCastPlayer.h

playableDuration

@property (nonatomic, readonly) NSTimeInterval playableDuration
Discussion

Get the duration of the buffered content

Declared In

APSChromeCastPlayer.h

playbackState

@property (nonatomic, readonly) MPMoviePlaybackState playbackState
Discussion

Get the current playback state

Declared In

APSChromeCastPlayer.h

scalingMode

@property (nonatomic) MPMovieScalingMode scalingMode
Discussion

Get or set the scaling mode of the video according to its viewport

Declared In

APSChromeCastPlayer.h

shouldAutoplay

@property (nonatomic) BOOL shouldAutoplay
Discussion

Get or set if the player should autoplay an URL as soon as it is provided

Declared In

APSChromeCastPlayer.h

timedMetadata

@property (nonatomic, readonly) NSArray *timedMetadata
Discussion

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

Returns an array of the most recent MPTimedMetadata objects provided by the media stream.

Declared In

APSChromeCastPlayer.h

view

@property (nonatomic, strong) UIView *view
Discussion

The container UIView of the player.

Declared In

APSChromeCastPlayer.h

Class Methods

backendPriority

+ (NSInteger)backendPriority
Discussion

The priority based on which the backend will be selected

Declared In

APSChromeCastPlayer.h

Instance Methods

beginSeekingBackward

- (void)beginSeekingBackward
Discussion

Rewind the media

Declared In

APSChromeCastPlayer.h

beginSeekingForward

- (void)beginSeekingForward
Discussion

Play the media with an increased playback rate (speed)

Declared In

APSChromeCastPlayer.h

endSeeking

- (void)endSeeking
Discussion

Stop the seeking process startd by beginSeekingForward or beginSeekingBackward;

Declared In

APSChromeCastPlayer.h

getMute

- (BOOL)getMute
Discussion

Get if the player is muted or no

Return Value

The mute status

Declared In

APSChromeCastPlayer.h

getVolume

- (CGFloat)getVolume
Discussion

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

Return Value

The sound volume of the player

Declared In

APSChromeCastPlayer.h

initWithURLs:

- (id)initWithURLs:(NSArray *)urls
Discussion

Create a APSAVPlayer instance

Parameters

urls

A NSArray of NSURLs pointing to the media location

Return Value

The APSAVPlayer instance

Declared In

APSChromeCastPlayer.h

pause

- (void)pause
Discussion

Pause the current playing media

Declared In

APSChromeCastPlayer.h

play

- (void)play
Discussion

Play the current media in the queue

Declared In

APSChromeCastPlayer.h

prepareToPlay

- (void)prepareToPlay
Discussion

Add an URL to the current play queue

Parameters

url

A NSURL instance pointing to the media location

Declared In

APSChromeCastPlayer.h

requestThumbnailImagesAtTimes:timeOption:

- (void)requestThumbnailImagesAtTimes:(NSArray *)playbackTimes timeOption:(MPMovieTimeOption)option
Discussion

Request a thumbnail image

Parameters

playbackTimes

A NSArray of NSTimeInterval, in seconds, when the thumbnail should be taken from the video

option

Precision

Return Value

The thumbnail image

Declared In

APSChromeCastPlayer.h

setMute:

- (void)setMute:(BOOL)mute
Discussion

Mute the player

Parameters

mute

BOOL set YES to mute or NO to unmute.

Declared In

APSChromeCastPlayer.h

setVolume:

- (void)setVolume:(CGFloat)volume
Discussion

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

Parameters

volume

CGFloat sound volume.

Declared In

APSChromeCastPlayer.h

stop

- (void)stop
Discussion

Stop the player, remove all the items from the queue and remove the player’s CALayer from its superlayer

Declared In

APSChromeCastPlayer.h

streamSourceType

- (APSMoviePlayerSourceType)streamSourceType
Discussion

Get the stream’s source type. Different by movieSourceType because it returns if the stream is a VOD stream or a live stream.

Return Value

The stream’s type as a APSMoviePlayerSourceType enum

Declared In

APSChromeCastPlayer.h

thumbnailAt:

- (UIImage *)thumbnailAt:(NSTimeInterval)playbackTime
Discussion

Request a thumbnail image

Parameters

playbackTime

The time, in seconds, when the thumbnail should be taken from the video

Return Value

The thumbnail image

Declared In

APSChromeCastPlayer.h

thumbnailImageAtTime:timeOption:

- (UIImage *)thumbnailImageAtTime:(NSTimeInterval)playbackTime timeOption:(MPMovieTimeOption)option
Discussion

Request a thumbnail image

Parameters

playbackTime

The time, in seconds, when the thumbnail should be taken from the video

option

Precision

Return Value

The thumbnail image

Declared In

APSChromeCastPlayer.h

CocoaDocs.org - APSMPMoviePlayer Class Reference

VeesoPlayer2.0.28

Inherits from MPMoviePlayerController
Conforms to APSMediaPlayerProtocol
KRAdapter
Declared in APSMPMoviePlayer.h

Tasks

Class Methods

backendPriority

+ (NSInteger)backendPriority
Discussion

The priority based on which the backend will be selected

Declared In

APSMPMoviePlayer.h

Instance Methods

getMute

- (BOOL)getMute
Discussion

Get if the player is muted or no

Return Value

The mute status

Declared In

APSMPMoviePlayer.h

getVolume

- (CGFloat)getVolume
Discussion

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

Return Value

The sound volume of the player

Declared In

APSMPMoviePlayer.h

setMute:

- (void)setMute:(BOOL)mute
Discussion

Mute the player

Parameters

mute

BOOL set YES to mute or NO to unmute.

Declared In

APSMPMoviePlayer.h

setVolume:

- (void)setVolume:(CGFloat)volume
Discussion

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

Parameters

volume

CGFloat sound volume.

Declared In

APSMPMoviePlayer.h

CocoaDocs.org - APSMediaBuilder Class Reference

VeesoPlayer2.0.28

Inherits from KRHub : NSObject
Declared in APSMediaBuilder.h

Overview

The APSMediaBuilder assists in creating playlists of fully configurable APSMediaUnits, together with attached, configurable APSMediaOverlays, using JSON files or using a NSDictionary, both following the same structure.

The media builder also has class methods that assist with the generation of individual APSMediaUnit and APSMediaOverlay objects from corresponding JSON or NSDictionary structures.

Plugins can be attached to a media builder. Each plugin can dynamically insert, edit or remove units and/or overlays from the generated playlist.

Tasks

Unit and Overlay Factory Methods

Media Builder Initialization

Media Builder Configuration

Properties

  •   userAgent

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

         property
  •   debugMode

    This property enables or disables console logging on all generated units.

         property

Generating the Final Playlist

Adding Plugins

Properties

bumperUnits

@property (nonatomic) NSArray *bumperUnits
Discussion

Array containing APSMediaUnits that will be scheduled before ones in contentUnits in the generated playlist.

Declared In

APSMediaBuilder.h

contentUnits

@property (nonatomic) NSArray *contentUnits
Discussion

Array containing the main content APSMediaUnits that will make up the playlist.

In the finally rendered playlist, units from bumperUnits will be prefixed to the main content units, while units from exitUnits will be inserted after the main content units. Every array’s content may be modified by attached builder plugins.

Declared In

APSMediaBuilder.h

debugMode

@property (nonatomic) BOOL debugMode
Discussion

This property enables or disables console logging on all generated units.

Declared In

APSMediaBuilder.h

exitUnits

@property (nonatomic) NSArray *exitUnits
Discussion

Array containing APSMediaUnits that will be scheduled after ones in contentUnits in the generated playlist.

Declared In

APSMediaBuilder.h

userAgent

@property (nonatomic) NSString *userAgent
Discussion

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

Declared In

APSMediaBuilder.h

Class Methods

overlayFromDictionary:

+ (APSMediaOverlay *)overlayFromDictionary:(NSDictionary *)overlayConfigurations
Discussion

Factory method to generate new instance of APSMediaOverlay via NSDictionary configuration.

Parameters

overlayConfigurations

Dictionary overlay configuration.

Return Value

An instance of APSMediaOverlay or nil if error.

Declared In

APSMediaBuilder.h

unitFromDictionary:

+ (APSMediaUnit *)unitFromDictionary:(NSDictionary *)unitConfigurations
Discussion

Factory method to generate new instance of APSMediaUnit via NSDictionary configuration.

Parameters

unitConfigurations

Dictionary unit configuration.

Return Value

An instance of APSMediaUnit or nil if error.

Declared In

APSMediaBuilder.h

Instance Methods

addPlugin:

- (void)addPlugin:(NSObject<APSMediaBuilderPlugin> *)plugin
Discussion

Registers a new plugin.

Parameters

plugin

The new plugin object. Must implement APSMediaBuilderPlugin.

Declared In

APSMediaBuilder.h

configureFromData:

- (BOOL)configureFromData:(NSData *)data
Discussion

Configures the builder from a NSData object.

Warning: UTF8 encoding is assumed.

Parameters

data

Configuration data - UTF8 encoded.

Return Value

YES on succes.

Declared In

APSMediaBuilder.h

configureFromDictionary:

- (BOOL)configureFromDictionary:(NSDictionary *)configuration
Discussion

Configures the builder from a NSDictionary object.

Parameters

configuration

The configuration dictionary.

Return Value

YES on succes.

Declared In

APSMediaBuilder.h

configureFromURL:

- (BOOL)configureFromURL:(NSURL *)url
Discussion

Configures the builder from a JSON structure.

Warning: This method may execute blocking network I/O on the calling thread.

Parameters

url

The URL of the JSON structure to load. This can be a remote file or a local file.

Return Value

YES on succes.

Declared In

APSMediaBuilder.h

configureFromURL:onComplete:

- (void)configureFromURL:(NSURL *)url onComplete:(void ( ^ ) ( ))block
Discussion

Configures the builder asynchronously from a JSON structure.

Parameters

url

The URL of the JSON structure to load. This can be a remote file or a local file.

block

The block to be executed after configuration is finished.

Declared In

APSMediaBuilder.h

initWithMediaUnit:

- (instancetype)initWithMediaUnit:(APSMediaUnit *)contentUnit
Discussion

Initializes builder with a playlist of a single media unit.

Parameters

contentUnit

APSMediaUnit object to be played.

Return Value

APSMediaBuilder object.

Declared In

APSMediaBuilder.h

initWithMediaUnits:

- (instancetype)initWithMediaUnits:(NSArray *)contentUnits
Discussion

Initializes builder with a playlist of media units.

Parameters

contentUnits

Array of APSMediaUnit objects to be played.

Return Value

APSMediaBuilder object.

Declared In

APSMediaBuilder.h

mediaUnits

- (NSArray *)mediaUnits
Discussion

Returns a generated playlist of APSMediaUnits, based on builder configuration and registered plugins.

Warning: This method may execute blocking network I/O on the calling thread.

Return Value

An array of APSMediaUnits.

Declared In

APSMediaBuilder.h

requestMediaUnitsWithCompletionBlock:

- (void)requestMediaUnitsWithCompletionBlock:(void ( ^ ) ( NSArray *))block
Discussion

Asynchronously generates a playlist of APSMediaUnits, based on builder configuration and registered plugins.

Parameters

block

The block to be executed when playlist is generated.

Declared In

APSMediaBuilder.h

CocoaDocs.org - APSMediaEvent Class Reference

VeesoPlayer2.0.28

Inherits from NSObject
Conforms to APSMediaEventProtocol
Declared in APSMediaEvent.h

Overview

The APSMediaEvent class describes a container that developers can use to instruct the player to run specific blocks of code at specific moments of time. Objects extending this class and implementing the corresponding APSMediaEventProtocol protocol can be added to the player’s main queue and can also be attached to a specific APSMediaUnit object, for runtime triggering.

Tasks

Configuring the Event Interval

  • – setStartPoint:

    Sets the starting time point of the event.
  • – setEndPoint:

    Sets the ending time point of the event.
  • – startPoint

    The time interval (in seconds) when the player needs to trigger the event.
  • – endPoint

    The playback time (in seconds) when the player needs to unload the event. Defaults to -1 for events that should unload right after triggering.
  •   repeatAfter

    If this parameter is greater than 0, then the event will be retriggered by the media player after the specific time interval (in seconds).

         property
  • – incrementStartAndEndPointsWithInterval:

    Shifts air-time for an event by a defined amount of time.
  • – adjustRelativeToDuration:

    Translates percentual values set via setStartPoint and setEndPoint to actual time intervals in seconds, relative to a specified total duration.

Asynchroneous Pre-Trigger

Asynchroneous Event Preloading

  •   preloadInterval

    Defines the number of seconds before the scheduled start point when the event should receive the [APSMediaEventProtocol preload] message (if the method is implemented).

         property
  •   timeout

    Defines the maximum number of seconds the event is allowed to live once it has been pretriggered, without setting the loaded property to YES.

         property
  •   state

    The current lifecycle state of the event.

         property
  •   preloadPoint

    Set by the player to the current playback time in seconds, after the current event begins preloading. Defaults to -1 if the event did not start preloading.

         property
  •   dynamicPosition property

Properties

dynamicPosition

@property BOOL dynamicPosition

preloadInterval

@property (nonatomic) NSTimeInterval preloadInterval
Discussion

Defines the number of seconds before the scheduled start point when the event should receive the [APSMediaEventProtocol preload] message (if the method is implemented).

Declared In

APSMediaEvent.h

preloadPoint

@property NSTimeInterval preloadPoint
Discussion

Set by the player to the current playback time in seconds, after the current event begins preloading. Defaults to -1 if the event did not start preloading.

Declared In

APSMediaEvent.h

repeatAfter

@property (nonatomic) NSTimeInterval repeatAfter
Discussion

If this parameter is greater than 0, then the event will be retriggered by the media player after the specific time interval (in seconds).

Declared In

APSMediaEvent.h

state

@property APSMediaEventState state
Discussion

The current lifecycle state of the event.

Declared In

APSMediaEvent.h

timeout

@property (nonatomic) NSTimeInterval timeout
Discussion

Defines the maximum number of seconds the event is allowed to live once it has been pretriggered, without setting the loaded property to YES.

Declared In

APSMediaEvent.h

Instance Methods

adjustRelativeToDuration:

- (void)adjustRelativeToDuration:(NSTimeInterval)duration
Discussion

Translates percentual values set via setStartPoint and setEndPoint to actual time intervals in seconds, relative to a specified total duration.

Parameters

duration

The total duration.

Declared In

APSMediaEvent.h

endPoint

- (NSTimeInterval)endPoint
Discussion

The playback time (in seconds) when the player needs to unload the event. Defaults to -1 for events that should unload right after triggering.

Warning: If percentual values were set via setStartPoint, this value will change immediately after the current clip’s duration is available.

Return Value

The final time interval.

Declared In

APSMediaEvent.h

incrementStartAndEndPointsWithInterval:

- (void)incrementStartAndEndPointsWithInterval:(NSTimeInterval)duration
Discussion

Shifts air-time for an event by a defined amount of time.

Parameters

duration

Shift duration in seconds.

Declared In

APSMediaEvent.h

preload

- (void)preload
Discussion

Call this to preload the event.

Declared In

APSMediaEvent.h

setEndPoint:

- (void)setEndPoint:(NSString *)endPoint
Discussion

Sets the ending time point of the event.

Parameters

endPoint

A string format describing the time point when the player needs to unload the event. Possible values are seconds (e.g.: @“60”) or a percentage relative to the total duration of the parent clip (e.g.: @“50%”).

Declared In

APSMediaEvent.h

setStartPoint:

- (void)setStartPoint:(NSString *)startPoint
Discussion

Sets the starting time point of the event.

Parameters

startPoint

A string format describing the time point when the player needs to trigger the event. Possible values are seconds (e.g.: @“60”) or a percentage relative to the total duration of the parent clip (e.g.: @“50%”).

Declared In

APSMediaEvent.h

startPoint

- (NSTimeInterval)startPoint
Discussion

The time interval (in seconds) when the player needs to trigger the event.

Warning: If percentual values were set via setStartPoint, this value will change immediately after the current clip’s duration is available.

Return Value

The initial time interval.

Declared In

APSMediaEvent.h

trigger

- (void)trigger
Discussion

Call this to trigger the event.

Declared In

APSMediaEvent.h

CocoaDocs.org - APSMediaOverlay Class Reference

VeesoPlayer2.0.28

Inherits from APSMediaEvent : NSObject
Conforms to APSMediaTrackableObject
NSCopying
Declared in APSMediaOverlay.h

Overview

APSMediaOverlay describes any overlay that the APSMediaPlayer instance needs to render during playback.

Tasks

Setting the Overlay Type and Parameters

  •   type

    Overlay type. The values that can be used with this property are usually constants defined by each individual overlay controller

         property
  •   parameters

    Overlay parameters. Implementation-specific to overlay controllers.

         property

Positioning the Overlay On-Screen

  •   position

    Describes the position the overlay should take when placed on-screen by the player. See APSMediaOverlayPosition for available values.

         property
  •   zIndex

    The order of the overlay in the current view stack.

         property
  •   width

    The width of the overlay. Supports pixels (e.g.: @“320”) or percentages, relative to the total width (e.g.: @“50%”).

         property
  •   height

    The height of the overlay. Supports pixels (e.g.: @“320”) or percentages, relative to the total height (e.g.: @“50%”).

         property
  •   absoluteOffsetX

    The overlay’s absolute horizontal offset, relative to the current origin. The current origin is determined by the overlay’s position parameter, while the positive direction is always toward the center of the player surface. Supports pixels (e.g.: @“320”) or percentages, relative to the total width (e.g.: @“50%”).

         property
  •   absoluteOffsetY

    The overlay’s absolute vertical offset, relative to the current origin. The current origin is determined by the overlay’s position parameter, while the positive direction is always toward the center of the player surface. Supports pixels (e.g.: @“320”) or percentages, relative to the total height (e.g.: @“50%”).

         property

Overlay Properties

  •   fadeInDuration

    The duration (in seconds) for the fade in effect of the overlay, when it is placed on and taken off screen.

         property
  •   removeWhenHidden

    Defines if the overlay should be removed from memory when its' opacity becomes zero.

         property
  •   parentUnit

    After being added to a APSMediaUnit object, a reference to this parent can be found here.

         property
  •   controller

    A refence to the overlay controller object. This is set by the player, on the overlay’s initial render.

         property
  •   metadata

    Additional overlay information.

         property

Other

Properties

absoluteOffsetX

@property (nonatomic) NSString *absoluteOffsetX
Discussion

The overlay’s absolute horizontal offset, relative to the current origin. The current origin is determined by the overlay’s position parameter, while the positive direction is always toward the center of the player surface. Supports pixels (e.g.: @“320”) or percentages, relative to the total width (e.g.: @“50%”).

Declared In

APSMediaOverlay.h

absoluteOffsetY

@property (nonatomic) NSString *absoluteOffsetY
Discussion

The overlay’s absolute vertical offset, relative to the current origin. The current origin is determined by the overlay’s position parameter, while the positive direction is always toward the center of the player surface. Supports pixels (e.g.: @“320”) or percentages, relative to the total height (e.g.: @“50%”).

Declared In

APSMediaOverlay.h

controller

@property (nonatomic) APSMediaPlayerOverlayController *controller
Discussion

A refence to the overlay controller object. This is set by the player, on the overlay’s initial render.

Declared In

APSMediaOverlay.h

fadeInDuration

@property (nonatomic) CGFloat fadeInDuration
Discussion

The duration (in seconds) for the fade in effect of the overlay, when it is placed on and taken off screen.

Declared In

APSMediaOverlay.h

height

@property (nonatomic) NSString *height
Discussion

The height of the overlay. Supports pixels (e.g.: @“320”) or percentages, relative to the total height (e.g.: @“50%”).

Declared In

APSMediaOverlay.h

metadata

@property (nonatomic) NSMutableDictionary *metadata
Discussion

Additional overlay information.

Declared In

APSMediaOverlay.h

parameters

@property (nonatomic) NSMutableDictionary *parameters
Discussion

Overlay parameters. Implementation-specific to overlay controllers.

Declared In

APSMediaOverlay.h

parentUnit

@property (nonatomic, weak) APSMediaUnit *parentUnit
Discussion

After being added to a APSMediaUnit object, a reference to this parent can be found here.

Declared In

APSMediaOverlay.h

position

@property (nonatomic) APSMediaOverlayPosition position
Discussion

Describes the position the overlay should take when placed on-screen by the player. See APSMediaOverlayPosition for available values.

Declared In

APSMediaOverlay.h

removeWhenHidden

@property (nonatomic) BOOL removeWhenHidden
Discussion

Defines if the overlay should be removed from memory when its' opacity becomes zero.

Declared In

APSMediaOverlay.h

type

@property (nonatomic) NSString *type
Discussion

Overlay type. The values that can be used with this property are usually constants defined by each individual overlay controller

Declared In

APSMediaOverlay.h

width

@property (nonatomic) NSString *width
Discussion

The width of the overlay. Supports pixels (e.g.: @“320”) or percentages, relative to the total width (e.g.: @“50%”).

Declared In

APSMediaOverlay.h

zIndex

@property (nonatomic) int zIndex
Discussion

The order of the overlay in the current view stack.

Declared In

APSMediaOverlay.h

Class Methods

positionFromString:

+ (APSMediaOverlayPosition)positionFromString:(NSString *)position
Discussion

Converts a string format to a APSMediaOverlayPosition value.

Parameters

position

The position of the overlay. Possible values are: - “top” - “topLeft” - “topRight” - “bottomLeft” - “bottomRight” - “bottom” - “fullscreen”

Return Value

The APSMediaOverlayPosition value coresponding to the string format.

Declared In

APSMediaOverlay.h

CocoaDocs.org - APSMediaPlayer Class Reference

VeesoPlayer2.0.28

Inherits from KRHub : NSObject
Conforms to GCKDeviceManagerDelegate
GCKDeviceScannerListener
TSMiniWebBrowserDelegate
UIActionSheetDelegate
UIViewControllerAnimatedTransitioning
UIViewControllerTransitioningDelegate
Declared in APSMediaPlayer.h

Overview

The APSMediaPlayer handles playback and rendering of APSMediaUnits and APSMediaOverlays.

Notifications

  • APSMediaPlayerWillEnterFullscreenNotification - Posted before the media player enters fullscreen
  • APSMediaPlayerWillExitFullscreenNotification - Posted before the media player exists 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 unit 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 error 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. See Apple’s documentation on MPMoviePlaybackState for more details about the available playback states.
  • 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
  • APSMediaPlayerInvalidLicenseNotification Posted when the player license is invalid. Playback will be disabled.

Constants

  • kAPSMediaPlayerOverlayControllersGroup - The group name that 3rd party overlay controllers must use when registering with the player.

Tasks

Accessing the APSMediaPlayer Instance and its View

Working with Media Units

Tracking Playback Events

URL Handling

  •   actionDelegate

    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.

         property
  •   modalViewControllerRoot

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

         property
  • – openURL:

    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.
  • – openURL:from:

    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).

Handling Playback

  •   isProcessing

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

         property
  • – play

    Starts playback of the current unit.
  • – pause

    Pauses playback of the current unit.
  • – interrupt
  • – stop

    Stops playback of the current unit.
  • – skip

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

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

    Proceeds to the next unit in the playlist.
  • – previous

    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.
  •   onFinish

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

         property

Getting Playback Information

Getting Video Thumbnails

Handling Fullscreen

Extending

Airplay

Chromecast

Other

Properties

actionDelegate

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

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.

Declared In

APSMediaPlayer.h

advertisingIdentifier

@property (nonatomic) NSString *advertisingIdentifier
Discussion

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

Declared In

APSMediaPlayer.h

allowsAirPlay

@property (nonatomic) BOOL allowsAirPlay
Discussion

Specifies whether the movie player allows AirPlay movie playback.

Declared In

APSMediaPlayer.h

backendPlayer

@property (nonatomic) enum APSBackendPlayer backendPlayer
Discussion

The backend player class. Use [APSAVPlayer class] for the AVPlayer-based backend or [APSMPMoviePlayer class] for the MPMoviePlayerController-based backend

Declared In

APSMediaPlayer.h

backendPlayerClass

@property (nonatomic, strong) Class backendPlayerClass
Discussion

A class which is compliant to APSMediaPlayerProtocol and which will be used as a backend player

Declared In

APSMediaPlayer.h

chromecastAppId

@property (nonatomic) NSString *chromecastAppId
Discussion

Set the Chromecast application ID to be launched when playing via Chromecast

Declared In

APSMediaPlayer.h

detectBreachedDevice

@property (nonatomic, assign) BOOL detectBreachedDevice
Discussion

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

Declared In

APSMediaPlayer.h

fullscreenOnLandscapeRotate

@property (nonatomic) BOOL fullscreenOnLandscapeRotate
Discussion

Enable auto-fullscreen on device orientation

Declared In

APSMediaPlayer.h

ignoreSilentSwitch

@property (nonatomic, assign) BOOL ignoreSilentSwitch
Discussion

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

Declared In

APSMediaPlayer.h

internalFullscreenSupport

@property (nonatomic) BOOL internalFullscreenSupport
Discussion

Set this to NO to disable internal fullscreen handling

Declared In

APSMediaPlayer.h

isFullscreen

@property (nonatomic, readonly) BOOL isFullscreen
Discussion

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

Declared In

APSMediaPlayer.h

isProcessing

@property (nonatomic, readonly) BOOL isProcessing
Discussion

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

Declared In

APSMediaPlayer.h

leaveFullscreenOnStop

@property (nonatomic) BOOL leaveFullscreenOnStop
Discussion

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

Declared In

APSMediaPlayer.h

modalViewControllerRoot

@property (nonatomic, weak) UIViewController *modalViewControllerRoot
Discussion

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

Declared In

APSMediaPlayer.h

onFinish

@property (nonatomic, copy) APSMediaPlayerFinishBlock onFinish
Discussion

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

Declared In

APSMediaPlayer.h

view

@property (nonatomic, readonly) UIView *view
Discussion

The container UIView of the player.

Declared In

APSMediaPlayer.h

Class Methods

durationFromString:

+ (NSTimeInterval)durationFromString:(NSString *)string
Discussion

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

Parameters

string

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

Return Value

The translated time interval in seconds.

Declared In

APSMediaPlayer.h

sharedInstance

+ (instancetype)sharedInstance
Discussion

Returns the shared APSMediaPlayer instance, creating it if necessary.

Return Value

The shared APSMediaPlayer instance

Declared In

APSMediaPlayer.h

Instance Methods

adbreaks

- (NSArray *)adbreaks

addEvents:

- (void)addEvents:(NSArray *)events
Discussion

Adds additional events to the current unit’s timeline.

Parameters

overlays

Additional APSMediaEvent objects to inject.

Declared In

APSMediaPlayer.h

addOverlays:

- (void)addOverlays:(NSArray *)overlays
Discussion

Adds additional overlays to display over the current unit.

Parameters

overlays

Additional APSMediaOverlay objects to inject.

Declared In

APSMediaPlayer.h

airPlayVideoActive

- (BOOL)airPlayVideoActive
Discussion

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

Declared In

APSMediaPlayer.h

chromecastActive

- (BOOL)chromecastActive

chromecastAvailable

- (BOOL)chromecastAvailable
Discussion

Indicates whether there is a Chromecast device available

Declared In

APSMediaPlayer.h

chromecastDevices

- (NSArray *)chromecastDevices
Discussion

Returns a list of detected GCKDevices

Declared In

APSMediaPlayer.h

clear

- (void)clear

connectToChromecastDevice:

- (void)connectToChromecastDevice:(GCKDevice *)device
Discussion

Connect to a specified device

Parameters

device

A GCKDevice to connect to

Declared In

APSMediaPlayer.h

currentChromecastDevice

- (GCKDevice *)currentChromecastDevice
Discussion

Get the current GCKDevice

Declared In

APSMediaPlayer.h

currentChromecastDeviceManager

- (GCKDeviceManager *)currentChromecastDeviceManager
Discussion

Get the current GCKDeviceManager

Declared In

APSMediaPlayer.h

currentChromecastMediaControlChannel

- (GCKMediaControlChannel *)currentChromecastMediaControlChannel
Discussion

Get the current media control channel

Declared In

APSMediaPlayer.h

currentPlaybackTime

- (NSTimeInterval)currentPlaybackTime
Discussion

Returns the current playback time.

Return Value

The current playback time.

Declared In

APSMediaPlayer.h

currentUnit

- (APSMediaUnit *)currentUnit
Discussion

Returns the currently playing media unit.

Return Value

An APSMediaUnit object representing the current unit.

Declared In

APSMediaPlayer.h

disconnectChromecast

- (void)disconnectChromecast

duration

- (NSTimeInterval)duration
Discussion

Returns the current unit’s video clip total duration.

Return Value

The video total duration.

Declared In

APSMediaPlayer.h

enterFullscreen

- (void)enterFullscreen
Discussion

Enter fullscreen mode.

Declared In

APSMediaPlayer.h

exitFullscreen

- (void)exitFullscreen
Discussion

Exit fullscreen mode.

Declared In

APSMediaPlayer.h

getMute

- (BOOL)getMute
Discussion

Get if the player is muted or no

Return Value

The mute status

Declared In

APSMediaPlayer.h

getVolume

- (CGFloat)getVolume
Discussion

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

Return Value

The sound volume of the player

Declared In

APSMediaPlayer.h

hideActivityIndicator

- (void)hideActivityIndicator
Discussion

Hides the player activity indicator.

Declared In

APSMediaPlayer.h

insertMediaUnits:

- (void)insertMediaUnits:(NSArray *)mediaUnits
Discussion

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

Parameters

mediaUnits

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

Declared In

APSMediaPlayer.h

interrupt

- (void)interrupt

isStreamingLive

- (BOOL)isStreamingLive
Discussion

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

Return Value

YES if the player is currently rendering a live stream.

Declared In

APSMediaPlayer.h

loadState

- (MPMovieLoadState)loadState
Discussion

Returns the current unit’s load state. See Apple’s documentation for more details about MPMovieLoadState.

Return Value

The current load state.

Declared In

APSMediaPlayer.h

movieSourceType

- (MPMovieSourceType)movieSourceType
Discussion

Returns the current unit’s movie source type. See Apple’s documentation for more details about MPMovieSourceType.

Return Value

The movie source type.

Declared In

APSMediaPlayer.h

next

- (void)next
Discussion

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

Declared In

APSMediaPlayer.h

openURL:

- (void)openURL:(NSURL *)url
Discussion

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.

Parameters

url

The URL that needs to be loaded.

Declared In

APSMediaPlayer.h

openURL:from:

- (void)openURL:(NSURL *)url from:(APSMediaPlayerOverlayController *)overlayController
Discussion

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).

Parameters

url

The URL that needs to be loaded.

overlay

The calling overlay controller.

Declared In

APSMediaPlayer.h

overlayControllerForType:

- (NSObject<APSMediaPlayerOverlayControllerProtocol> *)overlayControllerForType:(NSString *)type
Discussion

This method instantiates and returns a new object of the class registered for the given overlay type.

Parameters

type

The type of controller required.

Return Value

A new object that implements APSMediaPlayerOverlayControllerProtocol or nil if no controllers are registered for the given type.

Declared In

APSMediaPlayer.h

pause

- (void)pause
Discussion

Pauses playback of the current unit.

Declared In

APSMediaPlayer.h

play

- (void)play
Discussion

Starts playback of the current unit.

Declared In

APSMediaPlayer.h

playMediaUnits:

- (void)playMediaUnits:(NSArray *)mediaUnits
Discussion

Sets and begins playback of an array of media units.

Parameters

mediaUnits

An array of APSMediaUnit objects.

Declared In

APSMediaPlayer.h

playableDuration

- (NSTimeInterval)playableDuration
Discussion

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

Return Value

The video playable duration.

Declared In

APSMediaPlayer.h

playbackState

- (MPMoviePlaybackState)playbackState
Discussion

Returns the current unit’s playback state. See Apple’s documentation for more details about MPMoviePlaybackState.

Return Value

The current playback state.

Declared In

APSMediaPlayer.h

prepareMediaUnits:

- (void)prepareMediaUnits:(NSArray *)mediaUnits
Discussion

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

Parameters

mediaUnits

An array of APSMediaUnit objects.

Declared In

APSMediaPlayer.h

previous

- (void)previous
Discussion

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.

Declared In

APSMediaPlayer.h

registerOverlayController:

- (void)registerOverlayController:(Class<APSMediaPlayerOverlayControllerProtocol>)controllerClass
Discussion

Registers a new overlay controller with the player.

Parameters

controllerClass

The class of the new overlay controller.

Declared In

APSMediaPlayer.h

registerUnitManager:

- (void)registerUnitManager:(NSObject<APSUnitManagerProtocol> *)managerClass
Discussion

Registers a new unit manager to dynamically handle media playback.

Parameters

managerClass

The new unit manager object.

Declared In

APSMediaPlayer.h

replaceCurrentUnitWithUnits:

- (void)replaceCurrentUnitWithUnits:(NSArray *)mediaUnits
Discussion

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

Parameters

mediaUnits

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

Declared In

APSMediaPlayer.h

resetDisplayedOverlays

- (void)resetDisplayedOverlays
Discussion

Resets all displayed overlays.

Declared In

APSMediaPlayer.h

resetDisplayedOverlays:

- (void)resetDisplayedOverlays:(BOOL)animated
Discussion

Resets all displayed overlays.

Declared In

APSMediaPlayer.h

setCurrentPlaybackTime:

- (void)setCurrentPlaybackTime:(NSTimeInterval)playbackTime
Discussion

Sets the current playback time.

Parameters

playbackTime

The playback time to be set.

Declared In

APSMediaPlayer.h

setCurrentURL:

- (void)setCurrentURL:(NSURL *)url
Discussion

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

Parameters

url

The URL of the video clip.

Declared In

APSMediaPlayer.h

setFrame:

- (void)setFrame:(CGRect)frame
Discussion

Call this method to set the player view frame.

Parameters

frame

CGRect player view frame.

Declared In

APSMediaPlayer.h

setMediaUnits:

- (void)setMediaUnits:(NSArray *)mediaUnits
Discussion

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

Parameters

mediaUnits

An array of APSMediaUnit objects to create a new playlist.

Declared In

APSMediaPlayer.h

setMute:

- (void)setMute:(BOOL)mute
Discussion

Mute the player

Parameters

mute

BOOL set YES to mute or NO to unmute.

Declared In

APSMediaPlayer.h

setVolume:

- (void)setVolume:(CGFloat)volume
Discussion

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

Parameters

volume

CGFloat sound volume.

Declared In

APSMediaPlayer.h

showActivityIndicator

- (void)showActivityIndicator
Discussion

Shows an activity indicator, centrally in the player surface.

Declared In

APSMediaPlayer.h

showChromecastDevices

- (void)showChromecastDevices
Discussion

Show an UIActionSheet with detected devices

Declared In

APSMediaPlayer.h

skip

- (void)skip
Discussion

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

Declared In

APSMediaPlayer.h

step

- (void)step
Discussion

Proceeds to the next unit in the playlist.

Declared In

APSMediaPlayer.h

stop

- (void)stop
Discussion

Stops playback of the current unit.

Declared In

APSMediaPlayer.h

thumbnailImageAtTime:

- (UIImage *)thumbnailImageAtTime:(NSTimeInterval)time
Discussion

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

Warning: This method executes blocking operations on the calling thread.

Parameters

time

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

Return Value

The resulting thumbnail.

Declared In

APSMediaPlayer.h

timedMetadata

- (NSArray *)timedMetadata
Discussion

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

Return Value

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

Declared In

APSMediaPlayer.h

toggleFullscreen

- (void)toggleFullscreen
Discussion

Toggle the current fullscreen status.

Declared In

APSMediaPlayer.h

trackEvent:type:forObject:

- (void)trackEvent:(NSString *)event type:(NSString *)type forObject:(id)object
Discussion

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

Declared In

APSMediaPlayer.h

trackEvent:type:forObject:metadata:urls:

- (void)trackEvent:(NSString *)event type:(NSString *)type forObject:(id)object metadata:(NSDictionary *)metadata urls:(id)urls
Discussion

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.

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.

metadata

Additional key-value pairs to send via the notification’s userInfo to subscribers.

urls

An array of NSURL objects representing addresses that should be pinged. Also accepts an array of NSString objects, a single NSURL or a single NSString.

Declared In

APSMediaPlayer.h

unitsForAdbreak:

- (NSArray *)unitsForAdbreak:(APSVASTAdBreak *)adbreak
Discussion

Returns an array of units owned by an APSVASTAdbreak object

Declared In

APSMediaPlayer.h

CocoaDocs.org - APSMediaPlayerButtonOverlayController Class Reference

VeesoPlayer2.0.28

Inherits from APSMediaPlayerOverlayController : UIViewController
Declared in APSMediaPlayerButtonOverlayController.h

Overview

The APSMediaPlayerButtonOverlayController allows placing a transparent overlay in a specific area of the player surface, that can trigger the launch of a specific URL. The APSMediaPlayer instance will query the actionDelegate object to interpret and launch the specified URL. If the actionDelegate cannot respond to the URL, and the URL has a web scheme (http or https), it will be launched automatically in the in-app web browser.

Configuration

To create an APSMediaOverlay of button type:

  • set the overlay object’s type property to APSButtonOverlay

  • set the overlay object’s properties property to a NSDictionary that can have the following keys and values:

    • kAPSButtonOverlayClickthrough: set this key to a NSURL reprezenting the URL that should be launched when the overlay is tapped.
    • kAPSButtonOverlayClicktracking: set this key to a NSArray of NSURL objects that will be tracked by the player when the overlay is tapped (see [APSMediaPlayer track:forEvent:type:]). Note that the kAPSButtonOverlayClickthrough key must also be set for tracking to happen
    • kAPSButtonOverlayWebviewDismissAction: set this key to a NSNumber created from the APSWebviewDismissedAction value that defines the expected playlist behavior on in-app web browser dismiss.
CocoaDocs.org - APSMediaPlayerClosableOverlayController Class Reference

VeesoPlayer2.0.28

Inherits from APSMediaPlayerOverlayController : UIViewController
Declared in APSMediaPlayerClosableOverlayController.h

Overview

The APSMediaPlayerClosableOverlayController class is meant to be a superclass for overlay controllers that need to display a configurable close button to remove the overlay from screen.

The class adds a set of standard keys to any overlay controller’s own defined keys, to handle close button configuration. Methods are also exposed to allow a subclass to add and remove the close button from its view stack.

Tasks

Instance Methods

addCloseButtonWithParameters:

- (void)addCloseButtonWithParameters:(NSDictionary *)parameters
Discussion

This method adds the close button to the current view stack.

The close button is configurable using the provided dictionary structure. Available configuration keys and values are:

  • kAPSCloseImage: if set to a UIImage, that image will be used instead of the standard progress-wheel close button.
  • kAPSCloseSize: a NSNumber reprezenting the lenght of a side of the close button square, in points. Defaults to 16.
  • kAPSCloseBackgroundColor: the background color of the close button view. Set this to a UIColor or a NSString containing the hex color reprezentation. Defaults to [UIColor clearColor].
  • kAPSCloseXColor: the color of the X symbol in the center of the player. Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor darkGrayColor].
  • kAPSCloseProgressColor: the color of the circular bar that indicates the currently elapsed time until the close button can be tapped. Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor darkGrayColor].
  • kAPSCloseProgressTrackColor: the color of the circular bar that indicates the total time until the close button can be tapped. Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor lightGrayColor].
  • kAPSCloseOffsetX: the horizontal offset of the close button, relative to the right margin of the overlay’s view. Set this to a NSNumber. Defaults to 0.
  • kAPSCloseOffsetY: the vertical offset of the close button, relative to the top margin of the overlay’s view. Set this to a NSNumber. Defaults to 0.
  • kAPSCloseInitialAlpha: a NSNumber indicating the opacity of the close button before it is activated for receiving taps. Defaults to 0.5.
  • kAPSCloseFinalAlpha: a NSNumber indicating the opacity of the close button after it has been activated for receiving taps. Defaults to 0.7.
  • kAPSCloseHidden: set this key to @YES to skip displaying the close button for this overlay. Defaults to @NO.
  • kAPSCloseOffset: a NSNumber that indicates the offset, in seconds, after which the close button should become activated for receiving taps. Defaults to 3.
  • kAPSCloseTrackingURLs: a NSArray of NSURLs that will be tracked by the player when the close button is tapped and the overlay is removed (see [APSMediaPlayer track:forEvent:type:]).

Parameters

parameters

A dictionary containing configuration information.

Declared In

APSMediaPlayerClosableOverlayController.h

removeCloseButton

- (void)removeCloseButton
Discussion

This method removes the close button from the current view stack.

Declared In

APSMediaPlayerClosableOverlayController.h

CocoaDocs.org - APSMediaPlayerControlsOverlayController Class Reference

VeesoPlayer2.0.28

Inherits from APSMediaPlayerOverlayController : UIViewController
Declared in APSMediaPlayerControlsOverlayController.h
CocoaDocs.org - APSMediaPlayerHTMLOverlayController Class Reference

VeesoPlayer2.0.28

Inherits from APSMediaPlayerClosableOverlayController : APSMediaPlayerOverlayController : UIViewController
Conforms to UIWebViewDelegate
Declared in APSMediaPlayerHTMLOverlayController.h

Overview

The APSMediaPlayerHTMLOverlayController allows the inline loading of HTML content inside an overlay placed on top of video content.

Configuration

To create an APSMediaOverlay of HTML type:

  • set the overlay object’s type property to APSHTMLOverlay

  • set the overlay object’s properties property to a NSDictionary that can have the following keys and values:

    • kAPSHTMLCodeContent: the actual HTML NSString to be loaded.
    • kAPSHTMLIframeSource: NSString containing the URL that should be loaded inside an iframe element.
    • kAPSHTMLScriptSource: NSString containing the URL of the JavaScript file that should be loaded and executed.
    • kAPSHTMLPageSource: NSString containing the URL to load directly in the webview container.
    • kAPSHTMLWidth: NSNumber corresponding to the integer value to be set for the meta viewport width property.
    • kAPSHTMLHeight: NSNumber corresponding to the integer value to be set for the meta viewport height property.
    • kAPSHTMLErrorURLs: NSArray containing NSURLs to be tracked in case of error.
CocoaDocs.org - APSMediaPlayerImageOverlayController Class Reference

VeesoPlayer2.0.28

Inherits from APSMediaPlayerClosableOverlayController : APSMediaPlayerOverlayController : UIViewController
Declared in APSMediaPlayerImageOverlayController.h

Overview

The APSMediaPlayerImageOverlayController allows placing an image on top of video content.

Configuration

To create an APSMediaOverlay of image type:

  • set the overlay object’s type property to APSImageOverlay

  • set the overlay object’s properties property to a NSDictionary that can have the following keys and values:

    • kAPSImageOverlayClickthrough: set this key to a NSURL reprezenting the URL that should be launched when the overlay is tapped.
    • kAPSImageOverlayClicktracking: set this key to a NSArray of NSURL objects that will be tracked by the player when the overlay is tapped (see [APSMediaPlayer track:forEvent:type:]). Note that the kAPSImageOverlayClickthrough key must also be set for tracking to happen.
    • kAPSImageOverlayWebviewDismissAction: set this key to a NSNumber created from the APSWebviewDismissedAction value that defines the expected playlist behavior on in-app web browser dismiss.
    • kAPSImageOverlayViewtracking: set this key to a NSArray of NSURL objects that will be tracked by the player when the overlay is displayed (see [APSMediaPlayer track:forEvent:type:]).
    • kAPSImageOverlayResourceURL: NSURL reprezenting the image to be loaded.
    • kAPSImageOverlayErrorURLs: set this key to a NSArray of NSURL objects that will be tracked by the player when there is an error loading the image (see [APSMediaPlayer track:forEvent:type:]).
    • kAPSImageOverlayBackgroundColor: the background color of the overlay. Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor clearColor].

    • kAPSImageOverlayStretchMode: NSString reprezenting the possible ways of scaling the image in the overlay surface. Possible values are:

      • “aspectFit”, that will set the overlay’s contentMode to UIViewContentModeScaleAspectFit
      • “aspectFill”, that will set the overlay’s contentMode to UIViewContentModeScaleAspectFill
      • “fill”, that will set the overlay’s contentMode to UIViewContentModeScaleToFill
      • “center”, that will set the overlay’s contentMode to UIViewContentModeCenter
      • “bottom”, that will set the overlay’s contentMode to UIViewContentModeTop
      • “top”, that will set the overlay’s contentMode to UIViewContentModeBottom
      • “left”, that will set the overlay’s contentMode to UIViewContentModeLeft
      • “right”, that will set the overlay’s contentMode to UIViewContentModeRight
CocoaDocs.org - APSMediaPlayerOverlayController Class Reference

VeesoPlayer2.0.28

Inherits from UIViewController
Conforms to APSMediaPlayerOverlayControllerProtocol
Declared in APSMediaPlayerOverlayController.h

Overview

The superclass of all overlay controllers. Implements APSMediaPlayerOverlayControllerProtocol.

Tasks

Properties

overlay

@property (nonatomic, weak) APSMediaOverlay *overlay
Discussion

A reference to the APSMediaOverlay object associated with the current overlay controller.

Declared In

APSMediaPlayerOverlayController.h

CocoaDocs.org - APSMediaPlayerTextOverlayController Class Reference

VeesoPlayer2.0.28

Inherits from APSMediaPlayerOverlayController : UIViewController
Declared in APSMediaPlayerTextOverlayController.h

Overview

The APSMediaPlayerTextOverlayController allows the displaying text on top of video content.

Configuration

To create an APSMediaOverlay of text type:

  • set the overlay object’s type property to APSTextOverlay

  • set the overlay object’s properties property to a NSDictionary that can have the following keys and values:

    • kAPSTextOverlayString: the NSString to be rendered.
    • kAPSTextOverlayStringColor: Font color for the rendered text. Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor whiteColor].
    • kAPSTextOverlayStringFont: NSString indicating the font family to be used. Defaults to @“Helvetica”.
    • kAPSTextOverlayStringSize: NSNumber indicating the font size to be used. Defaults to 13.

Replacable Placeholders

The APSMediaPlayerTextOverlayController will replace the following string placeholders with dynamic information:

  • __remaining__ will be replaced with the remaining number of seconds for the current video clip being rendered.
  • __ad_index__ will be replaced with the current ad index within the ad break.
  • __total_ads__ will be replaced with the total number of ads within the ad break.
CocoaDocs.org - APSMediaPlayerVimeoOverlayController Class Reference

VeesoPlayer2.0.28

Inherits from APSMediaPlayerOverlayController : UIViewController
Conforms to UIWebViewDelegate
Declared in APSMediaPlayerVimeoOverlayController.h
CocoaDocs.org - APSMediaPlayerYoutubeOverlayController Class Reference

VeesoPlayer2.0.28

Inherits from APSMediaPlayerOverlayController : UIViewController
Conforms to UIWebViewDelegate
Declared in APSMediaPlayerYoutubeOverlayController.h
CocoaDocs.org - APSMediaUnit Class Reference

VeesoPlayer2.0.28

Inherits from NSObject
Conforms to APSMediaTrackableObject
NSCopying
Declared in APSMediaUnit.h

Overview

The APSMediaUnit class represents a clip that’s ready to be rendered by the player. A media unit also references an array of APSMediaOverlay objects, defining the overlays connected to the unit.

Tasks

Creating a media unit

Managing the media overlays connected to the current unit

Unit Properties

Ad Handling

  •   seekHandling

    Defines how mid content ads should be handled when the user has skipped over several batches. Use this parameter to instruct the player to render: only the first ad batch, only the last ad batch or all passed ad batches. Defaults to APSHandleSeekEventPlayLastBreak.

         property
  •   midcontentAdMinimumInitialOffset

    For ad breaks assigned to this unit without an ad offset (breaks that should be auto-positioned within the content), this parameter defines the minimum time interval in seconds to wait before displaying the first ad batch. Defaults to 300 seconds.

         property
  •   midcontentAdMinimumFinalOffset

    For ad breaks assigned to this unit without an ad offset (breaks that should be auto-positioned within the content), this parameter defines the minimum time interval in seconds (relative to the end of the video) that should be ad-free. Defaults to 300 seconds.

         property
  •   midcontentAdMinimumSpacing

    For ad breaks assigned to this unit without an ad offset (breaks that should be auto-positioned within the content), this parameter defines the minimum time interval in seconds to wait between ad batches. Defaults to 300 seconds.

         property

Utility Methods

Properties

adbreak

@property (nonatomic, weak) APSVASTAdBreak *adbreak
Discussion

The APSVASTAdBreak objects which created this unit

Declared In

APSMediaUnit.h

buffet

@property (nonatomic) NSMutableArray *buffet
Discussion

An array of other media units to be played instead of the current one, should an error be encountered. The unit at index 0 has the highest priority.

Declared In

APSMediaUnit.h

canReplay

@property (nonatomic) BOOL canReplay
Discussion

Defines whether the player can replay the current unit or not after it has ended in the playlist.

Declared In

APSMediaUnit.h

controlsDisplay

@property (nonatomic) APSMediaControlsDisplay controlsDisplay
Discussion

Defines how the controls bar will be displayed for the unit. See APSMediaControlsDisplay for possible values.

Declared In

APSMediaUnit.h

controlsParameters

@property (nonatomic) NSDictionary *controlsParameters
Discussion

The configuration for the controls bar overlay.

The following keys are available:

  • kAPSControlsBarColor: Set this to a UIColor that represents the background color of the controls bar.
  • kAPSControlsBarAlpha: NSNumber that represents the opacity of the controls bar.
  • kAPSControlsComponents: Set this to a mask that you get using OR operations on APSControlsOverlayComponents constants.
  • kAPSControlsPlayedTrackColor: The UIColor of the portion of the seek bar that indicates the currently played duration of the movie.
  • kAPSControlsBufferedTrackColor: The UIColor of the portion of the seek bar that indicates the currently buffered duration of the movie.
  • kAPSControlsEmptyTrackColor: The UIColor of the portion of the seek bar that indicates the currently unbuffered duration of the movie.
  • kAPSControlsPlayImage: The UIImage of the play button to use in the playback controls bar. Only displayed if the playback component is selected.
  • kAPSControlsPauseImage: The UIImage of the pause button to use in the playback controls bar. Only displayed if the playback component is selected.
  • kAPSControlsFullscreenImage: The UIImage of the fullscreen button to use in the playback controls bar. Only displayed if the playback component is selected.
  • kAPSControlsPreviousImage: The UIImage of the back button to use in the playback controls bar. Only displayed if the back button component is selected.
  • kAPSControlsNextImage: The UIImage of the forward button to use in the playback controls bar. Only displayed if the forward button component is selected.
  • kAPSControlsVisibileOnlyInFullscreen: Defines whether the playback controls bar should only be visible while the player is in fullscreen mode. This is useful if implementing a custom player UX for normal mode. Set this to a NSNumber boolean.
  • kAPSControlsAutohideDuration: The number of seconds the playback controls bar should automatically become hidden after. Set this to a NSNumber.
  • kAPSControlsLiveText: The text to display instead of the total video duration, for live streams. Only has effect when the total duration component is selected. Defaults to @"LIVE".
  • kAPSControlsPlaybackTimeText: The text to display instead of the current playback time, for live streams. Only has effect when the current playback time component is selected.
  • kAPSControlsUpdateCurrentTimeWhileSeeking: The current time text is showing the current seek position when dragging the seek bar

Declared In

APSMediaUnit.h

debug

@property (nonatomic) BOOL debug
Discussion

Toggle to enable logs.

Declared In

APSMediaUnit.h

initialPlaybackTime

@property (nonatomic) NSTimeInterval initialPlaybackTime
Discussion

Initial video playback time in seconds.

Declared In

APSMediaUnit.h

managerType

@property (nonatomic) NSString *managerType
Discussion

Assigns a unit manager to the current unit. See APSUnitManagerProtocol for more information.

Declared In

APSMediaUnit.h

metadata

@property (nonatomic) NSMutableDictionary *metadata
Discussion

Additional unit key-value information.

Declared In

APSMediaUnit.h

midcontentAdMinimumFinalOffset

@property (nonatomic, assign) NSTimeInterval midcontentAdMinimumFinalOffset
Discussion

For ad breaks assigned to this unit without an ad offset (breaks that should be auto-positioned within the content), this parameter defines the minimum time interval in seconds (relative to the end of the video) that should be ad-free. Defaults to 300 seconds.

Declared In

APSMediaUnit.h

midcontentAdMinimumInitialOffset

@property (nonatomic, assign) NSTimeInterval midcontentAdMinimumInitialOffset
Discussion

For ad breaks assigned to this unit without an ad offset (breaks that should be auto-positioned within the content), this parameter defines the minimum time interval in seconds to wait before displaying the first ad batch. Defaults to 300 seconds.

Declared In

APSMediaUnit.h

midcontentAdMinimumSpacing

@property (nonatomic, assign) NSTimeInterval midcontentAdMinimumSpacing
Discussion

For ad breaks assigned to this unit without an ad offset (breaks that should be auto-positioned within the content), this parameter defines the minimum time interval in seconds to wait between ad batches. Defaults to 300 seconds.

Declared In

APSMediaUnit.h

pinchToFullscreen

@property (nonatomic) BOOL pinchToFullscreen
Discussion

Defines if pinch-to-fullscreen should be allowed.

Declared In

APSMediaUnit.h

scalingMode

@property (nonatomic) MPMovieScalingMode scalingMode
Discussion

The video clip scaling mode, relative to the player surface. See Apple’s documentation for more details on MPMovieScalingMode. Defaults to MPMovieScalingModeNone.

Declared In

APSMediaUnit.h

seekHandling

@property (nonatomic, assign) APSHandleSeekEvent seekHandling
Discussion

Defines how mid content ads should be handled when the user has skipped over several batches. Use this parameter to instruct the player to render: only the first ad batch, only the last ad batch or all passed ad batches. Defaults to APSHandleSeekEventPlayLastBreak.

Declared In

APSMediaUnit.h

shouldAutoplay

@property (nonatomic) BOOL shouldAutoplay
Discussion

Defines if the unit should start playing as soon as it loads or wait for a play command.

Declared In

APSMediaUnit.h

url

@property (nonatomic) NSURL *url
Discussion

The video clip URL.

Declared In

APSMediaUnit.h

Class Methods

scalingModeFromString:

+ (MPMovieScalingMode)scalingModeFromString:(NSString *)string
Discussion

Converts a string format to a MPMovieScalingMode value. See Apple’s documentation for more details on MPMovieScalingMode.

Possible input values are:

  • “aspectFit”, that will be converted to MPMovieScalingModeAspectFit
  • “aspectFill”, that will be converted to MPMovieScalingModeAspectFill
  • “fill”, that will be converted to MPMovieScalingModeFill

Parameters

string

A string format to be converted.

Return Value

A MPMovieScalingMode value.

Declared In

APSMediaUnit.h

Instance Methods

addEvent:

- (void)addEvent:(APSMediaEvent *)overlay
Discussion

Adds an object that implements the APSMediaEvent protocol to the unit.

Parameters

overlay

The event to be connected to the unit.

Declared In

APSMediaUnit.h

addOverlay:

- (void)addOverlay:(APSMediaOverlay *)overlay
Discussion

Adds an APSMediaOverlay object to the unit, to be rendered together.

Parameters

overlay

The APSMediaOverlay object to be connected to the unit.

Declared In

APSMediaUnit.h

clearEvents

- (void)clearEvents
Discussion

Removes all currently connected events.

Declared In

APSMediaUnit.h

clearOverlays

- (void)clearOverlays
Discussion

Removes all currently connected overlays.

Declared In

APSMediaUnit.h

dynamicEvents

- (NSArray *)dynamicEvents

events

- (NSArray *)events
Discussion

Returns an array containing all event objects currently connected to the unit.

Return Value

An array of objects that implement the APSMediaEvent protocol.

Declared In

APSMediaUnit.h

initWithURL:

- (APSMediaUnit *)initWithURL:(NSURL *)url
Discussion

Initializes a media unit object.

Parameters

url

The video clip URL.

Return Value

A new APSMediaUnit object

Declared In

APSMediaUnit.h

overlays

- (NSArray *)overlays
Discussion

Returns an array containing all APSMediaOverlay objects currently connected to the unit.

Return Value

An array of APSMediaOverlay objects.

Declared In

APSMediaUnit.h

removeEvent:

- (void)removeEvent:(APSMediaEvent *)event
Discussion

Removes a specific media event.

Declared In

APSMediaUnit.h

setEvents:

- (void)setEvents:(NSArray *)events
Discussion

Connects an array of objects that implement the APSMediaEvent protocol to the current unit.

Parameters

overlays

An array of events to be connected to the unit.

Declared In

APSMediaUnit.h

setOverlays:

- (void)setOverlays:(NSArray *)overlays
Discussion

Connects an array of APSMediaOverlay objects to the current unit.

Parameters

overlays

An array of APSMediaOverlay objects to be connected to the unit.

Declared In

APSMediaUnit.h

CocoaDocs.org - APSTimedMetadata Class Reference

VeesoPlayer2.0.28

Inherits from MPTimedMetadata
Declared in APSTimedMetadata.h

Tasks

APSTimedMetadata initialization

Instance Methods

initWithMetadataItem:

- (id)initWithMetadataItem:(AVMetadataItem *)item
Discussion

Create and return a new APSTimedMetadata instance based on an AVMetadataItem

Parameters

item

An AVMetadataItem instance

Declared In

APSTimedMetadata.h

CocoaDocs.org - APSVASTAdBreak Class Reference

VeesoPlayer2.0.28

Inherits from APSMediaEvent : NSObject
Conforms to APSMediaTrackableObject
NSCopying
Declared in APSVASTAdBreak.h

Overview

An APSVASTAdBreak object defines an ad break for which the builder plugin will try to generate APSMediaUnits and insert them into the playlist.

Tasks

Main Configuration

  •   sources

    An array of NSString objects indicating the VAST URLs that will be called in order to populate the ad break with ads.

         property
  •   type

    The ad break type. Specifies how the rezulting APSMediaUnits and APSMediaOverlays need to be placed relative to the main content units. See APSVASTConfigurationOptions for more details about the possible values.

         property
  •   adOffset

    A string format that defines when midrolls and nonlinear ads should be inserted mid-unit for each content unit.

         property
  •   repeatAfter

    Defines the time interval in seconds after which the ad break will be repeated.

         property
  •   userAgent

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

         property
  • – configureFromDictionary:

    Configure an AdBreak from a dictionary structure.

Configuring the Playback Controls Bar

VAST 3.0 Icon Support

  •   defaultIconHeightPercentage

    Icons are rendered to a height that’s proportional to the current player view height. This property defines the percentage of the current height to render ads to, while preserving the original aspect ration in calculating the rendered width.

         property
  •   iconFadeInDuration

    The fade-in animation duration for displaying icons, in seconds.

         property

Skip Button Configuration

Fullscreen Button Configuration

Countdown to Next Unit Overlay Configuration

Ad Retrieval Settings

  •   allowMultipleAds

    Defines whether the break should allow more than one ad to be played, even if more ads are retrieved.

         property
  •   followWrappers

    Defines whether VAST Wrappers should be followed for the given URL sources.

         property
  •   multipleAdsConflictsPolicy

    The VMAP standard permits allowing only one ad from a certain ad source. This constant defines how the VAST builder plugin deals with situations when multiple valid ads are retrieved from a source that is disallowed to load several ads at one time.

         property
  •   adPodFallbackStrategy

    VAST 3.0 defines Ad Pods, with fallback mechanisms that allow loading an ad buffet of commercials to playback if the main ads fail. This value specifies how to treat backwards compatibility issues with VAST 2.0 and 1.0, by choosing what ads are promoted to the main Ad Pod if no valid Pods are detected.

         property
  •   prefferedVideoMimeTypes

    An array that defines the mime-types supported when choosing a media file from the VAST response.

         property

Other Configurations

  •   scalingMode

    The ad video clip scaling mode, relative to the player surface.

         property
  •   allowPinchToFullscreen

    Defines if the pinch-to-fullscreen gesture should be activated for generated video ads.

         property
  •   afterBannerTapped

    Defines the behavior of the player after a banner ad is tapped and the built-in web browser is dismissed.

         property
  •   afterVideoAdTapped

    Defines the behavior of the player after a video ad is tapped and the built-in web browser is dismissed.

         property
  •   debug

    Defines if the break should log debug information to the console.

         property
  •   metadata property

Properties

adOffset

@property (nonatomic) NSString *adOffset
Discussion

A string format that defines when midrolls and nonlinear ads should be inserted mid-unit for each content unit.

The expected format for this property is: “seconds” or “percentage%”.

Declared In

APSVASTAdBreak.h

adPodFallbackStrategy

@property (nonatomic) APSAdPodFallback adPodFallbackStrategy
Discussion

VAST 3.0 defines Ad Pods, with fallback mechanisms that allow loading an ad buffet of commercials to playback if the main ads fail. This value specifies how to treat backwards compatibility issues with VAST 2.0 and 1.0, by choosing what ads are promoted to the main Ad Pod if no valid Pods are detected.

See APSAdPodFallback for possible values. Defaults to APSAdPodFallbackSelectAll.

Declared In

APSVASTAdBreak.h

afterBannerTapped

@property (nonatomic) APSWebviewDismissedAction afterBannerTapped
Discussion

Defines the behavior of the player after a banner ad is tapped and the built-in web browser is dismissed.

Declared In

APSVASTAdBreak.h

afterVideoAdTapped

@property (nonatomic) APSWebviewDismissedAction afterVideoAdTapped
Discussion

Defines the behavior of the player after a video ad is tapped and the built-in web browser is dismissed.

Declared In

APSVASTAdBreak.h

allowMultipleAds

@property (nonatomic) BOOL allowMultipleAds
Discussion

Defines whether the break should allow more than one ad to be played, even if more ads are retrieved.

Declared In

APSVASTAdBreak.h

allowPinchToFullscreen

@property (nonatomic) BOOL allowPinchToFullscreen
Discussion

Defines if the pinch-to-fullscreen gesture should be activated for generated video ads.

Defaults to YES;

Declared In

APSVASTAdBreak.h

bannerConfiguration

@property (nonatomic) APSVASTBannerConfiguration *bannerConfiguration
Discussion

@name Non-linear Ads Configuration

Declared In

APSVASTAdBreak.h

controlsDisplayForAds

@property (nonatomic) APSMediaControlsDisplay controlsDisplayForAds
Discussion

Specifies how the controls bar will be displayed on top of video ads.

See APSMediaControlsDisplay for more details. Defaults to APSMediaControlsDisplayNone.

Declared In

APSVASTAdBreak.h

controlsParametersForAds

@property (nonatomic) NSDictionary *controlsParametersForAds
Discussion

The configuration for the controls bar overlay on top of video ads.

See [APSMediaUnit controlsParameters] for details on creating this dictionary.

Declared In

APSVASTAdBreak.h

countdownConfiguration

@property (nonatomic) APSVASTCountdownConfiguration *countdownConfiguration
Discussion

Holds the configuration object for the countdown overlay that appears on top of video ads.

Declared In

APSVASTAdBreak.h

debug

@property (nonatomic) BOOL debug
Discussion

Defines if the break should log debug information to the console.

Declared In

APSVASTAdBreak.h

defaultIconHeightPercentage

@property (nonatomic) CGFloat defaultIconHeightPercentage
Discussion

Icons are rendered to a height that’s proportional to the current player view height. This property defines the percentage of the current height to render ads to, while preserving the original aspect ration in calculating the rendered width.

Defaults to 10.

Declared In

APSVASTAdBreak.h

followWrappers

@property (nonatomic) BOOL followWrappers
Discussion

Defines whether VAST Wrappers should be followed for the given URL sources.

Declared In

APSVASTAdBreak.h

fullscreenButtonConfiguration

@property (nonatomic) APSVASTFullscreenButtonConfiguration *fullscreenButtonConfiguration
Discussion

Holds the configuration object for the fullscreen button that appears on top of video ads.

Declared In

APSVASTAdBreak.h

iconFadeInDuration

@property (nonatomic) CGFloat iconFadeInDuration
Discussion

The fade-in animation duration for displaying icons, in seconds.

Defaults to 0.5.

Declared In

APSVASTAdBreak.h

metadata

@property (nonatomic) NSMutableDictionary *metadata

multipleAdsConflictsPolicy

@property (nonatomic) APSResolvMultipleAdsConflictsBy multipleAdsConflictsPolicy
Discussion

The VMAP standard permits allowing only one ad from a certain ad source. This constant defines how the VAST builder plugin deals with situations when multiple valid ads are retrieved from a source that is disallowed to load several ads at one time.

See APSResolvMultipleAdsConflictsBy for possible values. Defaults to APSResolvMultipleAdsConflictsBySelectingFirst.

Declared In

APSVASTAdBreak.h

prefferedVideoMimeTypes

@property (nonatomic) NSArray *prefferedVideoMimeTypes
Discussion

An array that defines the mime-types supported when choosing a media file from the VAST response.

Items are ordered from most preferred to least preferred. The default value for this property is @[@"mobile/m3u8",@"application/x-mpegURL",@"application/vnd.apple.mpegURL",@"vnd.apple.mpegURL",@"video/m3u8",@"mobile/mp4",@"video/mp4"]

Declared In

APSVASTAdBreak.h

repeatAfter

@property (nonatomic) NSTimeInterval repeatAfter
Discussion

Defines the time interval in seconds after which the ad break will be repeated.

Declared In

APSVASTAdBreak.h

scalingMode

@property (nonatomic) MPMovieScalingMode scalingMode
Discussion

The ad video clip scaling mode, relative to the player surface.

See Apple’s documentation for more details on MPMovieScalingMode. Defaults to MPMovieScalingModeNone.

Declared In

APSVASTAdBreak.h

skipButtonConfiguration

@property (nonatomic) APSVASTSkipButtonConfiguration *skipButtonConfiguration
Discussion

Holds the configuration object for the skip button that appears on top of video ads.

Declared In

APSVASTAdBreak.h

sources

@property (nonatomic) NSArray *sources
Discussion

An array of NSString objects indicating the VAST URLs that will be called in order to populate the ad break with ads.

Declared In

APSVASTAdBreak.h

type

@property (nonatomic) APSVASTAdBreakType type
Discussion

The ad break type. Specifies how the rezulting APSMediaUnits and APSMediaOverlays need to be placed relative to the main content units. See APSVASTConfigurationOptions for more details about the possible values.

Declared In

APSVASTAdBreak.h

userAgent

@property (nonatomic) NSString *userAgent
Discussion

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

Declared In

APSVASTAdBreak.h

Instance Methods

configureFromDictionary:

- (void)configureFromDictionary:(NSDictionary *)configuration
Discussion

Configure an AdBreak from a dictionary structure.

Parameters

configuration

Configuration dictionary.

Declared In

APSVASTAdBreak.h

CocoaDocs.org - APSVASTBannerConfiguration Class Reference

VeesoPlayer2.0.28

Inherits from NSObject
Conforms to NSCopying
Declared in APSVASTBannerConfiguration.h

Overview

Holds all configuration parameters for the banner ads displayed.

Tasks
  •   maxSize

    The maximum allowed size for a non-linear ad. Non-linear ads that define sizes larger than this will be truncated.

         property
  •   stretchToMaxSize

    Defines if non-linear ads should be stretched to the defined bannerMaxSize, should they declare a size smaller than that.

         property
  •   position

    Defines how a non-linear banner overlay should be placed relative to the player surface.

         property
  •   fadeInDuration

    Defines the fade-in animation duration for non-linear ads.

         property
  •   defaultAdBreakDuration

    Defines the default number of seconds that a non-linear ad will be kept on display. This can be overridden by VAST ad configuration.

         property
  •   skipOffset

    Defines the default number of seconds after which the non-linear ad close button becomes active.

         property
  •   showCloseButton

    Indicates whether a close button should be displayed on top of non-linear ads.

         property
  •   closeButtonImage

    Defines the image that should be displayed in the non-linear ads close button, instead of the default progress wheel.

         property
  •   closeButtonBackgroundColor

    Defines the background color for the close button displayed on top of non-linear ads.

         property
  •   closeButtonXColor

    Defines the color for the X symbol in the center of the close button.

         property
  •   closeButtonSize

    Indicates the lenght of a side of the non-linear ads close button square.

         property
  •   closeButtonInitialAlpha

    Indicates the opacity of the non-linear ads close button before it is activated for receiving taps.

         property
  •   closeButtonFinalAlpha

    Indicates the opacity of the non-linear close button after it has been activated for receiving taps.

         property
  •   closeButtonProgressColor

    The color of the circular bar that indicates the currently elapsed time until the close button can be tapped.

         property
  •   closeButtonTrackColor

    The color of the circular bar that indicates the total time until the close button can be tapped.

         property
  •   closeButtonOffset

    Defines the offset that the non-linear ads close button should have from the top-right edge of the banner itself.

         property

Properties

closeButtonBackgroundColor

@property (nonatomic) NSString *closeButtonBackgroundColor
Discussion

Defines the background color for the close button displayed on top of non-linear ads.

Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor clearColor].

Declared In

APSVASTBannerConfiguration.h

closeButtonFinalAlpha

@property (nonatomic) float closeButtonFinalAlpha
Discussion

Indicates the opacity of the non-linear close button after it has been activated for receiving taps.

Defaults to 0.7.

Declared In

APSVASTBannerConfiguration.h

closeButtonImage

@property (nonatomic) UIImage *closeButtonImage
Discussion

Defines the image that should be displayed in the non-linear ads close button, instead of the default progress wheel.

Declared In

APSVASTBannerConfiguration.h

closeButtonInitialAlpha

@property (nonatomic) float closeButtonInitialAlpha
Discussion

Indicates the opacity of the non-linear ads close button before it is activated for receiving taps.

Defaults to 0.5.

Declared In

APSVASTBannerConfiguration.h

closeButtonOffset

@property (nonatomic) CGPoint closeButtonOffset
Discussion

Defines the offset that the non-linear ads close button should have from the top-right edge of the banner itself.

Declared In

APSVASTBannerConfiguration.h

closeButtonProgressColor

@property (nonatomic) NSString *closeButtonProgressColor
Discussion

The color of the circular bar that indicates the currently elapsed time until the close button can be tapped.

Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor darkGrayColor].

Declared In

APSVASTBannerConfiguration.h

closeButtonSize

@property (nonatomic) int closeButtonSize
Discussion

Indicates the lenght of a side of the non-linear ads close button square.

Defaults to 20.

Declared In

APSVASTBannerConfiguration.h

closeButtonTrackColor

@property (nonatomic) NSString *closeButtonTrackColor
Discussion

The color of the circular bar that indicates the total time until the close button can be tapped.

Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor lightGrayColor].

Declared In

APSVASTBannerConfiguration.h

closeButtonXColor

@property (nonatomic) NSString *closeButtonXColor
Discussion

Defines the color for the X symbol in the center of the close button.

Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor darkGrayColor].

Declared In

APSVASTBannerConfiguration.h

defaultAdBreakDuration

@property (nonatomic) int defaultAdBreakDuration
Discussion

Defines the default number of seconds that a non-linear ad will be kept on display. This can be overridden by VAST ad configuration.

Defaults to 10.

Declared In

APSVASTBannerConfiguration.h

fadeInDuration

@property (nonatomic) CGFloat fadeInDuration
Discussion

Defines the fade-in animation duration for non-linear ads.

Defaults to 0.5.

Declared In

APSVASTBannerConfiguration.h

maxSize

@property (nonatomic) CGSize maxSize
Discussion

The maximum allowed size for a non-linear ad. Non-linear ads that define sizes larger than this will be truncated.

Defaults to CGSizeMake(320, 50).

Declared In

APSVASTBannerConfiguration.h

position

@property (nonatomic) APSMediaOverlayPosition position
Discussion

Defines how a non-linear banner overlay should be placed relative to the player surface.

See APSMediaOverlayPosition for possible values. Defaults to kAPSMediaOverlayPositionBottom.

Declared In

APSVASTBannerConfiguration.h

showCloseButton

@property (nonatomic) BOOL showCloseButton
Discussion

Indicates whether a close button should be displayed on top of non-linear ads.

Defaults to YES.

Declared In

APSVASTBannerConfiguration.h

skipOffset

@property (nonatomic) int skipOffset
Discussion

Defines the default number of seconds after which the non-linear ad close button becomes active.

Defaults to 3.

Declared In

APSVASTBannerConfiguration.h

stretchToMaxSize

@property (nonatomic) BOOL stretchToMaxSize
Discussion

Defines if non-linear ads should be stretched to the defined bannerMaxSize, should they declare a size smaller than that.

Defaults to NO;

Declared In

APSVASTBannerConfiguration.h

CocoaDocs.org - APSVASTCountdownConfiguration Class Reference

VeesoPlayer2.0.28

Inherits from NSObject
Conforms to NSCopying
Declared in APSVASTCountdownConfiguration.h

Overview

Holds all configuration parameters for the coundown overlay displayed on top of video ads.

Tasks
  •   show

    Indicates whether the countdown until the next media starts should be displayed during video ads.

         property
  •   position

    The position of the countdown overlay, relative to the player surface.

         property
  •   text

    The text to be displayed in the countdown overlay. Use the “remaining” placeholder for the number of seconds.

         property
  •   width

    The width of the countdown overlay.

         property
  •   height
    • The height of the countdown overlay.
         property
  •   font

    The font family to be used for the text in the countdown overlay.

         property
  •   size

    The size of the font to be used for the text in the countdown overlay.

         property
  •   color

    The color of the font to be used for the text in the countdown overlay.

         property

Properties

color

@property (nonatomic) NSString *color
Discussion

The color of the font to be used for the text in the countdown overlay.

Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor whiteColor].

Declared In

APSVASTCountdownConfiguration.h

font

@property (nonatomic) NSString *font
Discussion

The font family to be used for the text in the countdown overlay.

Defaults to @“Helvetica”.

Declared In

APSVASTCountdownConfiguration.h

height

@property (nonatomic) NSString *height
Discussion
  • The height of the countdown overlay.

Defaults to @“30”.

Declared In

APSVASTCountdownConfiguration.h

position

@property (nonatomic) APSMediaOverlayPosition position
Discussion

The position of the countdown overlay, relative to the player surface.

See APSMediaOverlayPosition for possible values. Defaults to kAPSMediaOverlayPositionBottomLeft.

Declared In

APSVASTCountdownConfiguration.h

show

@property (nonatomic) BOOL show
Discussion

Indicates whether the countdown until the next media starts should be displayed during video ads.

Defaults to YES;

Declared In

APSVASTCountdownConfiguration.h

size

@property (nonatomic) int size
Discussion

The size of the font to be used for the text in the countdown overlay.

Defaults to 13.

Declared In

APSVASTCountdownConfiguration.h

text

@property (nonatomic) NSString *text
Discussion

The text to be displayed in the countdown overlay. Use the “remaining” placeholder for the number of seconds.

Declared In

APSVASTCountdownConfiguration.h

width

@property (nonatomic) NSString *width
Discussion

The width of the countdown overlay.

Defaults to @“64%”.

Declared In

APSVASTCountdownConfiguration.h

CocoaDocs.org - APSVASTFullscreenButtonConfiguration Class Reference

VeesoPlayer2.0.28

Inherits from NSObject
Conforms to NSCopying
Declared in APSVASTFullscreenButtonConfiguration.h

Tasks
  •   visible

    .

         property
  •   position

    The position of the fullscreen ad overlay, relative to the player surface.

         property
  •   padding

    The internal padding that the fullscreen overlay should apply to its content.

         property
  •   enterIconLocation

    An URL to the icon or a UIImage instance which will be used for the “enter fullscreen” action

         property
  •   leaveIconLocation

    An URL to the icon or a UIImage instance which will be used for the “leave fullscreen” action

         property
  •   borderColor

    The color of the border for the fullscreen overlay.

         property
  •   borderRadius

    The corner radius of the border for the fullscreen overlay.

         property
  •   backgroundColor

    The background color for the fullscreen overlay.

         property
  •   width

    The width of the fullscreen overlay.

         property
  •   height

    The height of the fullscreen overlay.

         property

Properties

backgroundColor

@property (nonatomic) NSString *backgroundColor
Discussion

The background color for the fullscreen overlay.

Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor clearColor].

Declared In

APSVASTFullscreenButtonConfiguration.h

borderColor

@property (nonatomic) NSString *borderColor
Discussion

The color of the border for the fullscreen overlay.

Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor lightGrayColor].

Declared In

APSVASTFullscreenButtonConfiguration.h

borderRadius

@property (nonatomic) int borderRadius
Discussion

The corner radius of the border for the fullscreen overlay.

Defaults to 5.

Declared In

APSVASTFullscreenButtonConfiguration.h

enterIconLocation

@property (nonatomic, strong) id enterIconLocation
Discussion

An URL to the icon or a UIImage instance which will be used for the “enter fullscreen” action

Defaults to APSMediaPlayer.bundle/Controls/fullscreen.png

Declared In

APSVASTFullscreenButtonConfiguration.h

height

@property (nonatomic) NSString *height
Discussion

The height of the fullscreen overlay.

Defaults to @“30”.

Declared In

APSVASTFullscreenButtonConfiguration.h

leaveIconLocation

@property (nonatomic, strong) id leaveIconLocation
Discussion

An URL to the icon or a UIImage instance which will be used for the “leave fullscreen” action

Defaults to APSMediaPlayer.bundle/Controls/fullscreen-exit.png

Declared In

APSVASTFullscreenButtonConfiguration.h

padding

@property (nonatomic) int padding
Discussion

The internal padding that the fullscreen overlay should apply to its content.

Defaults to 5.

Declared In

APSVASTFullscreenButtonConfiguration.h

position

@property (nonatomic) APSMediaOverlayPosition position
Discussion

The position of the fullscreen ad overlay, relative to the player surface.

See APSMediaOverlayPosition for possible values. Defaults to kAPSMediaOverlayPositionBottomRight.

Declared In

APSVASTFullscreenButtonConfiguration.h

visible

@property (nonatomic) BOOL visible
Discussion

.

See APSMediaOverlayPosition for possible values. Defaults to kAPSMediaOverlayPositionBottomRight.

Declared In

APSVASTFullscreenButtonConfiguration.h

width

@property (nonatomic) NSString *width
Discussion

The width of the fullscreen overlay.

Defaults to @“75”.

Declared In

APSVASTFullscreenButtonConfiguration.h

CocoaDocs.org - APSVASTFullscreenOverlayController Class Reference

VeesoPlayer2.0.28

Inherits from APSMediaPlayerOverlayController : UIViewController
Declared in APSVASTFullscreenOverlayController.h
CocoaDocs.org - APSVASTMediaBuilderPlugin Class Reference

VeesoPlayer2.0.28

Inherits from NSObject
Conforms to APSMediaBuilderPlugin
Declared in APSVASTMediaBuilderPlugin.h

Overview

The VAST Media Builder plugin extends an APSMediaBuilder object by inserting preroll, postroll, midroll and non-linear ad breaks, loaded from VAST 1.0, VAST 2.0, VAST 3.0 and VMAP 1.0 sources.

Use the [APSMediaBuilder addPlugin:] method to attach an APSVASTMediaBuilderPlugin object to a media builder.

Configuration of the plugin can be done in three ways:

  • programatically configure the plugin object, using available properties;
  • configure the plugin object directly, using a dictionary - see [APSMediaBuilderPlugin configureFromDictionary:];
  • configure the plugin with JSON. This is done as part of the APSMediaBuilder object configuration from JSON or from a dictionary. If the supplied configuration dictionary or interpreted JSON dictionary contains the “ads” key, then the corresponding value dictionary for that key will be provided to the plugin for configuration.

Tasks

Other Methods

Configuring Ad Breaks

  •   vmapURL

    The VMAP 1.0 URL that should be used to configure ad breaks.

         property
  •   adBreakTemplate

    The template object that holds default parameter values for ad breaks created from VMAP or VAST.

         property
  •   adBreaks

    The currently defined ad breaks that the plugin will try to fill.

         property

Other Configurations

  •   defaultAdBreakPositions

    When loading ads via VMAP and using ad break positioning via “#”, this array defines the available, pre-defined positions that ads can be inserted at.

         property

Properties

adBreakTemplate

@property (nonatomic) APSVASTAdBreak *adBreakTemplate
Discussion

The template object that holds default parameter values for ad breaks created from VMAP or VAST.

Declared In

APSVASTMediaBuilderPlugin.h

adBreaks

@property (nonatomic) NSArray *adBreaks
Discussion

The currently defined ad breaks that the plugin will try to fill.

Declared In

APSVASTMediaBuilderPlugin.h

defaultAdBreakPositions

@property (nonatomic) NSArray *defaultAdBreakPositions
Discussion

When loading ads via VMAP and using ad break positioning via “#”, this array defines the available, pre-defined positions that ads can be inserted at.

Positions are defined using strings that can either specify absolute time intervals in seconds (e.g.: @“10”) or percentual values, relative to the full playback time (e.g.: @“50%”). Defaults to @[@"5", @"75%"].

Declared In

APSVASTMediaBuilderPlugin.h

vmapURL

@property (nonatomic) NSURL *vmapURL
Discussion

The VMAP 1.0 URL that should be used to configure ad breaks.

Declared In

APSVASTMediaBuilderPlugin.h

Instance Methods

adBreaksForVMAP

- (NSArray *)adBreaksForVMAP
CocoaDocs.org - APSVASTSkipButtonConfiguration Class Reference

VeesoPlayer2.0.28

Inherits from NSObject
Conforms to NSCopying
Declared in APSVASTSkipButtonConfiguration.h

Overview

Holds all configuration parameters for the skip button displayed on top of video ads

Tasks
  •   position

    The position of the skip ad overlay, relative to the player surface.

         property
  •   defaultSkipOffset

    The default interval of time that needs to pass before the skip overlay is activated for tapping.

         property
  •   text

    The text that should be displayed in the skip button.

         property
  •   textColor

    The color of the text diplayed in the skip button.

         property
  •   progressPosition

    Defines where inside the skip overlay should the progress circle be rendered.

         property
  •   progressCircleColor

    Defines the color of the progress bar indicating the elapsed time since ad has started.

         property
  •   progressCircleTextColor

    Defines the color of the text in the middle of the progress circle, indicating the number of seconds left until skip activation.

         property
  •   progressCircleTrackColor

    Defines the color of the progress bar indicating the total duration of the ad.

         property
  •   padding

    The internal padding that the skip overlay should apply to its content.

         property
  •   borderColor

    The color of the border for the skip overlay.

         property
  •   borderRadius

    The corner radius of the border for the skip overlay.

         property
  •   backgroundColor

    The background color for the skip overlay.

         property
  •   width

    The width of the skip overlay.

         property
  •   height

    The height of the skip overlay.

         property

Properties

backgroundColor

@property (nonatomic) NSString *backgroundColor
Discussion

The background color for the skip overlay.

Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor clearColor].

Declared In

APSVASTSkipButtonConfiguration.h

borderColor

@property (nonatomic) NSString *borderColor
Discussion

The color of the border for the skip overlay.

Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor lightGrayColor].

Declared In

APSVASTSkipButtonConfiguration.h

borderRadius

@property (nonatomic) int borderRadius
Discussion

The corner radius of the border for the skip overlay.

Defaults to 5.

Declared In

APSVASTSkipButtonConfiguration.h

defaultSkipOffset

@property (nonatomic) int defaultSkipOffset
Discussion

The default interval of time that needs to pass before the skip overlay is activated for tapping.

The default value is -1, which makes the skip button invisible.

Declared In

APSVASTSkipButtonConfiguration.h

height

@property (nonatomic) NSString *height
Discussion

The height of the skip overlay.

Defaults to @“30”.

Declared In

APSVASTSkipButtonConfiguration.h

padding

@property (nonatomic) int padding
Discussion

The internal padding that the skip overlay should apply to its content.

Defaults to 5.

Declared In

APSVASTSkipButtonConfiguration.h

position

@property (nonatomic) APSMediaOverlayPosition position
Discussion

The position of the skip ad overlay, relative to the player surface.

See APSMediaOverlayPosition for possible values. Defaults to kAPSMediaOverlayPositionBottomRight.

Declared In

APSVASTSkipButtonConfiguration.h

progressCircleColor

@property (nonatomic) NSString *progressCircleColor
Discussion

Defines the color of the progress bar indicating the elapsed time since ad has started.

Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor lightGrayColor].

Declared In

APSVASTSkipButtonConfiguration.h

progressCircleTextColor

@property (nonatomic) NSString *progressCircleTextColor
Discussion

Defines the color of the text in the middle of the progress circle, indicating the number of seconds left until skip activation.

Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor clearColor].

Declared In

APSVASTSkipButtonConfiguration.h

progressCircleTrackColor

@property (nonatomic) NSString *progressCircleTrackColor
Discussion

Defines the color of the progress bar indicating the total duration of the ad.

Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor darkGrayColor].

Declared In

APSVASTSkipButtonConfiguration.h

progressPosition

@property (nonatomic) APSSkipOverlayProgressPosition progressPosition
Discussion

Defines where inside the skip overlay should the progress circle be rendered.

See APSSkipOverlayProgressPosition for more details. Defaults to kAPSSkipOverlayProgressPositionRight.

Declared In

APSVASTSkipButtonConfiguration.h

text

@property (nonatomic) NSString *text
Discussion

The text that should be displayed in the skip button.

Defaults to “Skip”.

Declared In

APSVASTSkipButtonConfiguration.h

textColor

@property (nonatomic) NSString *textColor
Discussion

The color of the text diplayed in the skip button.

Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor whiteColor].

Declared In

APSVASTSkipButtonConfiguration.h

width

@property (nonatomic) NSString *width
Discussion

The width of the skip overlay.

Defaults to @“75”.

Declared In

APSVASTSkipButtonConfiguration.h

CocoaDocs.org - APSVASTSkipOverlayController Class Reference

VeesoPlayer2.0.28

Inherits from APSMediaPlayerOverlayController : UIViewController
Declared in APSVASTSkipOverlayController.h
CocoaDocs.org - KRHub Class Reference

VeesoPlayer2.0.28

Inherits from NSObject
Declared in KRHub.h

Overview

A KRHub object can easily become a container of references to other objects or classes, organized in groups. To be able to register themselves with a KRHub, objects must implement the KRAdapter protocol. Within a single group there can not be more objects that declare the same type.

Tasks
  • – adaptersForGroup:

    Returns the list of available registered objects for a specified group.
  • – registerAdapter:

    Registers a new adapter to the default group.
  • – adapterForType:

    Returns an object of the specified type, if such an object is currently registered in the default group.
  • – registerAdapter:inGroup:

    Registeres a new adapter to a specific group
  • – adapterForType:inGroup:

    Returns an object of the specified type, if such an object is currently registered in the specified group.
  • – registerClass:inGroup:

    Registers a class to a specific group and a specific type. Upon requesting a new object from this group and type, a new object of the registered class will be instantiated and returned.
  • – registerClass:

    Registers a class to the default group, under a specific type. Upon requesting a new object from this type from the default group, a new object of the registered class will be instantiated and returned.

Instance Methods

adapterForType:

- (NSObject<KRAdapter> *)adapterForType:(NSString *)type
Discussion

Returns an object of the specified type, if such an object is currently registered in the default group.

Parameters

type

The required object type.

Return Value

An object if any is registered, nil otherwise.

Declared In

KRHub.h

adapterForType:inGroup:

- (NSObject<KRAdapter> *)adapterForType:(NSString *)type inGroup:(NSString *)group
Discussion

Returns an object of the specified type, if such an object is currently registered in the specified group.

Parameters

type

The required object type.

group

The required group.

Return Value

An object if any is registered, nil otherwise.

Declared In

KRHub.h

adaptersForGroup:

- (NSMutableDictionary *)adaptersForGroup:(NSString *)group
Discussion

Returns the list of available registered objects for a specified group.

Parameters

group

The required group.

Return Value

A dictionary containing all objects registered for the required group. The dictionary keys are the types, as specified by the objects.

Declared In

KRHub.h

registerAdapter:

- (void)registerAdapter:(NSObject<KRAdapter> *)adapter
Discussion

Registers a new adapter to the default group.

Parameters

adapter

The adapter to be registered. The object needs to implement KRAdapter.

Declared In

KRHub.h

registerAdapter:inGroup:

- (void)registerAdapter:(NSObject<KRAdapter> *)adapter inGroup:(NSString *)group
Discussion

Registeres a new adapter to a specific group

Parameters

adapter

The adapter to be registered. The object needs to implement KRAdapter.

group

The group to register the adapter into.

Declared In

KRHub.h

registerClass:

- (void)registerClass:(Class)cclass
Discussion

Registers a class to the default group, under a specific type. Upon requesting a new object from this type from the default group, a new object of the registered class will be instantiated and returned.

Parameters

cclass

The class to register

Declared In

KRHub.h

registerClass:inGroup:

- (void)registerClass:(Class)cclass inGroup:(NSString *)group
Discussion

Registers a class to a specific group and a specific type. Upon requesting a new object from this group and type, a new object of the registered class will be instantiated and returned.

Parameters

cclass

The class to register.

group

The group to register the call into.

Declared In

KRHub.h

CocoaDocs.org - APSAVPlayerSeekStatus Constants Reference

VeesoPlayer2.0.28

Declared in APSMediaPlayerProtocol.h

APSAVPlayerSeekStatus

Definition

typedef NS_ENUM(NSInteger, APSAVPlayerSeekStatus ) {
   APSAVPlayerSeekStatusNoSeeking,
   APSAVPlayerSeekStatusBackward,
   APSAVPlayerSeekStatusForward,
};

Constants

APSAVPlayerSeekStatusNoSeeking

APSMediaPlayerProtocol.h.

APSAVPlayerSeekStatusBackward

APSMediaPlayerProtocol.h.

APSAVPlayerSeekStatusForward

APSMediaPlayerProtocol.h.

CocoaDocs.org - APSAdPodFallback Constants Reference

VeesoPlayer2.0.28

Declared in APSVASTAdBreak.h

APSAdPodFallback

VAST 3.0 defines Ad Pods, with fallback mechanisms that allow loading an ad buffet of commercials to playback if the main ads fail. This value specifies how to treat backwards compatibility issues with VAST 2.0 and 1.0, by choosing what ads are promoted to the main Ad Pod if no valid Pods are detected.

Definition

typedef NS_ENUM(NSInteger, APSAdPodFallback ) {
   APSAdPodFallbackSelectAll,
   APSAdPodFallbackSelectFirst,
   APSAdPodFallbackDrop,
};

Constants

APSAdPodFallbackSelectAll

Load all retrieved ads if no valid Ad Pods are found.

APSVASTAdBreak.h.

APSAdPodFallbackSelectFirst

Load only the first retrieved ad if no valid Ad Pods are found.

APSVASTAdBreak.h.

APSAdPodFallbackDrop

Drop the whole ad request if no valid Ad Pods are found. This value will disable VAST 1.0 and 2.0 compatibility.

APSVASTAdBreak.h.

Declared In

APSVASTAdBreak.h
CocoaDocs.org - APSBackendPlayer Constants Reference

VeesoPlayer2.0.28

Declared in APSMediaPlayer.h

APSBackendPlayer

Definition

typedef NS_ENUM(NSInteger, APSBackendPlayer ) {
   APSBackendAVPlayer,
   APSBackendMPMoviePlayer,
   APSBackendChromecastPlayer,
   APSBackendCustomPlayer,
};

Constants

APSBackendAVPlayer

APSMediaPlayer.h.

APSBackendMPMoviePlayer

APSMediaPlayer.h.

APSBackendChromecastPlayer

APSMediaPlayer.h.

APSBackendCustomPlayer

APSMediaPlayer.h.

CocoaDocs.org - APSControlsOverlayComponents Constants Reference

VeesoPlayer2.0.28

Declared in APSMediaPlayerControlsOverlayController.h

APSControlsOverlayComponents

Controls bar components.

Definition

typedef NS_OPTIONS(NSUInteger, APSControlsOverlayComponents ) {
   APSCurrentTimeControl = 1 < < 0,
   APSTimeSliderControl = 1 < < 1,
   APSTotalTimeControl = 1 < < 2,
   APSAirPlayControl = 1 < < 3,
   APSChromecastControl = 1 < < 4,
   APSFullScreenControl = 1 < < 5,
   APSThumbnailTimeSliderControl = 1 < < 6,
   APSPreviousControl = 1 < < 7,
   APSNextControl = 1 < < 8,
   APSPlaybackControl = 1 < < 9,
   APSAdMarksControl = 1 < < 10,
};

Constants

APSCurrentTimeControl

The current playback time counter.

APSMediaPlayerControlsOverlayController.h.

APSTimeSliderControl

The seek bar (time slider) control.

APSMediaPlayerControlsOverlayController.h.

APSTotalTimeControl

The total playback time display.

APSMediaPlayerControlsOverlayController.h.

APSAirPlayControl

The AirPlay video control. This control only appears when an AirPlay ready device is detected in the current network.

APSMediaPlayerControlsOverlayController.h.

APSChromecastControl

The Chromecast video control. This control only appears when a Chromecast ready device is detected in the current network.

APSMediaPlayerControlsOverlayController.h.

APSFullScreenControl

The fullscreen toggle control.

APSMediaPlayerControlsOverlayController.h.

APSThumbnailTimeSliderControl

The seek bar (time slider) control, with mid-seek thumbnail support.

APSMediaPlayerControlsOverlayController.h.

APSPreviousControl

Control allowing the user to return to previous unit in the playlist.

APSMediaPlayerControlsOverlayController.h.

APSNextControl

Control allowing the user to proceed to the next unit in the playlist.

APSMediaPlayerControlsOverlayController.h.

APSPlaybackControl

The play/stop control.

APSMediaPlayerControlsOverlayController.h.

APSAdMarksControl

The ad marks

APSMediaPlayerControlsOverlayController.h.

Declared In

APSMediaPlayerControlsOverlayController.h
CocoaDocs.org - APSHandleSeekEvent Constants Reference

VeesoPlayer2.0.28

Declared in APSMediaUnit.h

APSHandleSeekEvent

Specifies how the unit should handle seeking through multiple ad breaks.

Definition

typedef NS_ENUM(NSInteger, APSHandleSeekEvent ) {
   APSHandleSeekEventPlayFirstBreak,
   APSHandleSeekEventPlayLastBreak,
   APSHandleSeekEventPlayAllBreaks,
};

Constants

APSHandleSeekEventPlayFirstBreak

This will only trigger the first ad break.

APSMediaUnit.h.

APSHandleSeekEventPlayLastBreak

This will only trigger the last ad break.

APSMediaUnit.h.

APSHandleSeekEventPlayAllBreaks

This will trigger all ad breaks.

APSMediaUnit.h.

Declared In

APSMediaUnit.h
CocoaDocs.org - APSMediaControlsDisplay Constants Reference

VeesoPlayer2.0.28

Declared in APSMediaUnit.h

APSMediaControlsDisplay

Specifies how the controls bar should be displayed for a media unit.

Definition

typedef NS_ENUM(NSInteger, APSMediaControlsDisplay ) {
   APSMediaControlsDisplayBottom,
   APSMediaControlsDisplayTop,
   APSMediaControlsDisplayNone,
};

Constants

APSMediaControlsDisplayBottom

The controls bar should be displayed at the bottom of the player surface.

APSMediaUnit.h.

APSMediaControlsDisplayTop

The controls bar should be displayed at the top of the player surface.

APSMediaUnit.h.

APSMediaControlsDisplayNone

The controls bar should not be displayed for this unit.

APSMediaUnit.h.

Declared In

APSMediaUnit.h
CocoaDocs.org - APSMediaEventState Constants Reference

VeesoPlayer2.0.28

Declared in APSMediaEvent.h

APSMediaEventState

Describes the current lifecycle state of a APSMediaEvent.

Definition

typedef NS_ENUM(NSInteger, APSMediaEventState ) {
   APSMediaEventStateUnloaded,
   APSMediaEventStatePreloading,
   APSMediaEventStatePreloaded,
   APSMediaEventStateFailed,
   APSMediaEventStateTriggered,
   APSMediaEventStateFinished,
};

Constants

APSMediaEventStateUnloaded

The event has not yet been loaded.

APSMediaEvent.h.

APSMediaEventStatePreloading

The event is currently preloading.

APSMediaEvent.h.

APSMediaEventStatePreloaded

The event has succesfully preloaded and is ready to be triggered.

APSMediaEvent.h.

APSMediaEventStateFailed

The event failed to preload and should not be triggered.

APSMediaEvent.h.

APSMediaEventStateTriggered

The event is triggered.

APSMediaEvent.h.

APSMediaEventStateFinished

The event finished.

APSMediaEvent.h.

Declared In

APSMediaEvent.h
CocoaDocs.org - APSMediaOverlayPosition Constants Reference

VeesoPlayer2.0.28

Declared in APSMediaOverlay.h

APSMediaOverlayPosition

Describes the position the overlay should take when placed on-screen by the player.

Definition

typedef NS_ENUM(NSInteger, APSMediaOverlayPosition ) {
   kAPSMediaOverlayPositionFullscreen,
   kAPSMediaOverlayPositionBottomLeft,
   kAPSMediaOverlayPositionBottomRight,
   kAPSMediaOverlayPositionTopLeft,
   kAPSMediaOverlayPositionTopRight,
   kAPSMediaOverlayPositionTop,
   kAPSMediaOverlayPositionBottom,
   kAPSMediaOverlayPositionLeft,
   kAPSMediaOverlayPositionRight,
   kAPSMediaOverlayPositionUnspecified,
};

Constants

kAPSMediaOverlayPositionFullscreen

The overlay should be stretched to fit the whole player surface.

APSMediaOverlay.h.

kAPSMediaOverlayPositionBottomLeft

The overlay should be bottom-left aligned with the player surface.

APSMediaOverlay.h.

kAPSMediaOverlayPositionBottomRight

The overlay should be bottom-right aligned with the player surface.

APSMediaOverlay.h.

kAPSMediaOverlayPositionTopLeft

The overlay should be top-left aligned with the player surface.

APSMediaOverlay.h.

kAPSMediaOverlayPositionTopRight

The overlay should be top-right aligned with the player surface.

APSMediaOverlay.h.

kAPSMediaOverlayPositionTop

The overlay should be placed centrally in the top of the player surface.

APSMediaOverlay.h.

kAPSMediaOverlayPositionBottom

The overlay should be placed centrally at the bottom of the player surface.

APSMediaOverlay.h.

kAPSMediaOverlayPositionLeft

The overlay should be vertically centered to the left of the player surface.

APSMediaOverlay.h.

kAPSMediaOverlayPositionRight

The overlay should be vertically centered to the right of the player surface.

APSMediaOverlay.h.

kAPSMediaOverlayPositionUnspecified

The overlay will not be placed on screen.

APSMediaOverlay.h.

Declared In

APSMediaOverlay.h
CocoaDocs.org - APSMoviePlayerSourceType Constants Reference

VeesoPlayer2.0.28

Declared in APSMediaPlayerProtocol.h

APSMoviePlayerSourceType

Definition

typedef NS_ENUM(NSInteger, APSMoviePlayerSourceType ) {
   APSMoviePlayerSourceTypeOnDemand,
   APSMoviePlayerSourceTypeLive,
};

Constants

APSMoviePlayerSourceTypeOnDemand

APSMediaPlayerProtocol.h.

APSMoviePlayerSourceTypeLive

APSMediaPlayerProtocol.h.

CocoaDocs.org - APSResolvMultipleAdsConflictsBy Constants Reference

VeesoPlayer2.0.28

Declared in APSVASTAdBreak.h

APSResolvMultipleAdsConflictsBy

The VMAP standard permits allowing only one ad from a certain ad source. This constant defines how the VAST builder plugin deals with situations when multiple valid ads are retrieved from a source that is disallowed to load several ads at one time.

Definition

typedef NS_ENUM(NSInteger, APSResolvMultipleAdsConflictsBy ) {
   APSResolvMultipleAdsConflictsByDropping,
   APSResolvMultipleAdsConflictsBySelectingFirst,
   APSResolvMultipleAdsConflictsBySelectingRandom,
};

Constants

APSResolvMultipleAdsConflictsByDropping

Solve the issue by dropping all loaded ads.

APSVASTAdBreak.h.

APSResolvMultipleAdsConflictsBySelectingFirst

Solve the issue by only inserting the first valid ad retrieved, honoring the defined order in the VAST.

APSVASTAdBreak.h.

APSResolvMultipleAdsConflictsBySelectingRandom

Solve the issue by only inserting one random ad from the loaded batch.

APSVASTAdBreak.h.

Declared In

APSVASTAdBreak.h
CocoaDocs.org - APSSkipOverlayProgressPosition Constants Reference

VeesoPlayer2.0.28

Declared in APSVASTSkipOverlayController.h

APSSkipOverlayProgressPosition

Defines where inside the skip overlay should the progress circle be rendered.

Definition

typedef NS_ENUM(NSInteger, APSSkipOverlayProgressPosition ) {
   kAPSSkipOverlayProgressPositionLeft,
   kAPSSkipOverlayProgressPositionRight,
   kAPSSkipOverlayProgressPositionHidden,
};

Constants

kAPSSkipOverlayProgressPositionLeft

Render the progress circle in the left side of the skip overlay.

APSVASTSkipOverlayController.h.

kAPSSkipOverlayProgressPositionRight

Render the progress circle in the right side of the skip overlay.

APSVASTSkipOverlayController.h.

kAPSSkipOverlayProgressPositionHidden

Do not render the progress circle.

APSVASTSkipOverlayController.h.

Declared In

APSVASTSkipOverlayController.h
CocoaDocs.org - APSVASTAdBreakType Constants Reference

VeesoPlayer2.0.28

Declared in APSVASTAdBreak.h

APSVASTAdBreakType

Defines how an APSVASTAdBreak should be placed relative to the main content units.

Definition

typedef NS_ENUM(NSInteger, APSVASTAdBreakType ) {
   APSVASTPreContent,
   APSVASTPostContent,
   APSVASTMidContent,
   APSVASTNonLinear,
};

Constants

APSVASTPreContent

Place the APSMediaUnits corresponding to the ad break at the beginning of the main content units.

APSVASTAdBreak.h.

APSVASTPostContent

Place the APSMediaUnits corresponding to the ad break at the end of the main content units.

APSVASTAdBreak.h.

APSVASTMidContent

Place the APSMediaUnits corresponding to the ad break in the middle of each main content unit, at a defined offset (see the adOffset property of APSVASTAdBreak).

APSVASTAdBreak.h.

APSVASTNonLinear

Place the APSMediaOverlays corresponding to the ad break in the middle of each main content unit, ad a defined offset (see the adOffset property of APSVASTAdBreak).

APSVASTAdBreak.h.

Declared In

APSVASTAdBreak.h
CocoaDocs.org - APSWebviewDismissedAction Constants Reference

VeesoPlayer2.0.28

Declared in APSMediaPlayerOverlayController.h

APSWebviewDismissedAction

Defines the action that the player should take when resuming playback after an interruption caused by user interaction, that determined the display of the in-app web browser.

Definition

typedef NS_ENUM(NSInteger, APSWebviewDismissedAction ) {
   APSHideOverlayOnWebviewDismiss,
   APSSkipUnitOnWebviewDismiss,
   APSDoNothingOnWebviewDismiss,
};

Constants

APSHideOverlayOnWebviewDismiss

Player should hide the calling overlay on webview dismiss.

APSMediaPlayerOverlayController.h.

APSSkipUnitOnWebviewDismiss

Player should skip the current unit on webview dismiss.

APSMediaPlayerOverlayController.h.

APSDoNothingOnWebviewDismiss

No action should be taken on webview dismiss.

APSMediaPlayerOverlayController.h.

Declared In

APSMediaPlayerOverlayController.h
CocoaDocs.org - APSMediaBuilderPlugin Protocol Reference

VeesoPlayer2.0.28

Conforms to KRAdapter
Declared in APSMediaBuilderPlugin.h

Overview

Defines methods that need to be implemented by any object that want to register as an APSMediaBuilder plugin.

Tasks

Plugin Execution

Plugin Dictionary Configuration

  • – dictionaryConfigurationKey

    The string key that will be used in the root of JSON and dictionary builder configurations to hold all the specific configuration details for the plugin.

         required method
  • – configureFromDictionary:

    This method is called by the APSMediaBuilder object, in the process of its configuration. The method is only called if in the root of the configuring JSON or NSDictionary there is a key equal to the string defined by the plugin using the dictionaryConfigurationKey method.

         required method

Instance Methods

configureFromDictionary:

- (void)configureFromDictionary:(NSDictionary *)configuration
Discussion

This method is called by the APSMediaBuilder object, in the process of its configuration. The method is only called if in the root of the configuring JSON or NSDictionary there is a key equal to the string defined by the plugin using the dictionaryConfigurationKey method.

Parameters

configuration

A NSDictionary object containing the specific plugin configuration data.

Declared In

APSMediaBuilderPlugin.h

dictionaryConfigurationKey

- (NSString *)dictionaryConfigurationKey
Discussion

The string key that will be used in the root of JSON and dictionary builder configurations to hold all the specific configuration details for the plugin.

Return Value

String key.

Declared In

APSMediaBuilderPlugin.h

startForBuilder:

- (void)startForBuilder:(APSMediaBuilder *)builder
Discussion

This method will be called at the beginning of the mediaUnits method of the APSMediaBuilder object that registered the plugin.

Parameters

builder

A reference to the calling APSMediaBuilder object.

Declared In

APSMediaBuilderPlugin.h

CocoaDocs.org - APSMediaEventProtocol Protocol Reference

VeesoPlayer2.0.28

Conforms to NSObject
Declared in APSMediaEvent.h

Overview

The APSMediaEventProtocol protocol describes methods that objects extending the associated APSMediaEvent class must or can implement.

Tasks
  • – onTrigger

    This code will be executed once the event is triggered by the player.

         required method
  • – onPreload

    This method will be invoked on a different thread by the player, before the event start point, as set by the [APSMediaEvent preTriggerInterval] property.
  • – onUpdate

    This method will be invoked by the player periodically, giving the event the opportunity to respond to updated playback information.
  • – onUnload

    This method will be invoked by the player once the event has reached the end point and will be deallocated.

Instance Methods

onPreload

- (void)onPreload
Discussion

This method will be invoked on a different thread by the player, before the event start point, as set by the [APSMediaEvent preTriggerInterval] property.

Declared In

APSMediaEvent.h

onTrigger

- (void)onTrigger
Discussion

This code will be executed once the event is triggered by the player.

Declared In

APSMediaEvent.h

onUnload

- (void)onUnload
Discussion

This method will be invoked by the player once the event has reached the end point and will be deallocated.

Declared In

APSMediaEvent.h

onUpdate

- (void)onUpdate
Discussion

This method will be invoked by the player periodically, giving the event the opportunity to respond to updated playback information.

Declared In

APSMediaEvent.h

CocoaDocs.org - APSMediaPlayerActionDelegate Protocol Reference

VeesoPlayer2.0.28

Conforms to NSObject
Declared in APSMediaPlayer.h

Overview

The APSMediaPlayerActionDelegate protocol declares the two methods that a class must implement in order to become an APSMediaPlayer actionDelegate. The object implementing APSMediaPlayer will receive information about the URLs that need to be executed as the user interacts with the player.

Tasks
  • – canRespondTo:

    Returns a Boolean value indicating whether the receiver is able to interpret and react to the given input NSURL.

         required method
  • – respondTo:

    If the APSMediaPlayerActionDelegate implementing object returns YES from the canRespondTo method for a certain URL, this method will be triggered to request effective execution.

         required method

Instance Methods

canRespondTo:

- (BOOL)canRespondTo:(NSURL *)url
Discussion

Returns a Boolean value indicating whether the receiver is able to interpret and react to the given input NSURL.

Parameters

url

The URL that needs to be launched.

Return Value

YES if the object can interpret and react to the given input URL, NO otherwise.

Declared In

APSMediaPlayer.h

respondTo:

- (void)respondTo:(NSURL *)url
Discussion

If the APSMediaPlayerActionDelegate implementing object returns YES from the canRespondTo method for a certain URL, this method will be triggered to request effective execution.

Parameters

url

The URL that needs to be launched.

Declared In

APSMediaPlayer.h

CocoaDocs.org - APSMediaPlayerOverlayControllerProtocol Protocol Reference

VeesoPlayer2.0.28

Conforms to KRAdapter
Declared in APSMediaPlayerOverlayController.h

Overview

The APSMediaPlayerOverlayController defines all the methods that a UIViewController subclass must or can implement to be able to register as an overlay controller with the player. This protocol extends the KRAdapter protocol, so objects should also define a unique string type to register under.

Tasks

Overlay Initialization

  • – load

    This method is invoked by the player when first diplaying the overlay controller object.

         required method
  • – preload

    This method is invoked by the player on a background thread, before the overlay start point, as set by the [APSMediaEvent preTriggerInterval] property.

Callbacks

  • – update

    This method is called whenever the playback state of the player is changed (e.g. current playback time changes, playback state changes etc.). If the overlay controller needs to update its interface as a result of these changes, the updates should be performed in this method.
  • – overlayWillBeRemoved

    This method is invoked by the player, before the overlay controller’s view is removed from the player surface. Any overlay cleanup code should be performed in this method.
  • – didEnterFullscreen

    This method is invoked by the player, when fullscreen mode is enabled.
  • – didExitFullscreen

    This method is invoked by the player, when fullscreen mode is disabled.

Handling Playback

  • – currentPlaybackTime

    Allows an overlay controller to return a current playback time in place of the parent APSMediaUnit object, if the url property of that object is nil.
  • – playableDuration

    Allows an overlay controller to return a total playable (buffered) time in place of the parent APSMediaUnit object, if the url property of that object is nil.
  • – setCurrentPlaybackTime:

    Allows an overlay that handles media playback in place of the parent unit to internally set the current playback time.
  • – duration

    Allows an overlay controller to return a total playback duration in place of the parent APSMediaUnit object, if the url property of that object is nil.
  • – playbackState

    Allows an overlay controller to return a playback state in place of the parent APSMediaUnit object, if the url property of that object is nil. See Apple’s documentation for more details about MPMoviePlaybackState.
  • – loadState

    Allows an overlay controller to return a load state in place of the parent APSMediaUnit object, if the url property of that object is nil. See Apple’s documentation for more details about MPMovieLoadState.
  • – movieSourceType

    Allows an overlay controller to return a media source type in place of the parent APSMediaUnit object, if the url property of that object is nil. See Apple’s documentation for more details about MPMovieSourceType.
  • – play

    Allows an overlay that handles media playback in place of the parent unit to start playback.
  • – stop

    Allows an overlay that handles media playback in place of the parent unit to stop playback.
  • – pause

    Allows an overlay that handles media playback in place of the parent unit to pause playback.
  • – thumbnailImageAtTime:

    Allows an overlay that handles media playback in place of the parent unit to return a thumbnail image at a specific time interval from the managed video.

Defining Behavior for Webview Dismiss Events

  • – onWebviewDismiss

    Allows an overlay controller to specify what action the player should take when it comes back into focus, after a modal in-app web browser was triggered and dismissed by user interaction.

Instance Methods

currentPlaybackTime

- (NSTimeInterval)currentPlaybackTime
Discussion

Allows an overlay controller to return a current playback time in place of the parent APSMediaUnit object, if the url property of that object is nil.

This occurs for overlays that handle media playback in place of the parent unit, for e.g. the Youtube player overlay controller. * * @return The current overlay-managed playback time, in seconds.

Declared In

APSMediaPlayerOverlayController.h

didEnterFullscreen

- (void)didEnterFullscreen
Discussion

This method is invoked by the player, when fullscreen mode is enabled.

Declared In

APSMediaPlayerOverlayController.h

didExitFullscreen

- (void)didExitFullscreen
Discussion

This method is invoked by the player, when fullscreen mode is disabled.

Declared In

APSMediaPlayerOverlayController.h

duration

- (NSTimeInterval)duration
Discussion

Allows an overlay controller to return a total playback duration in place of the parent APSMediaUnit object, if the url property of that object is nil.

This occurs for overlays that handle media playback in place of the parent unit, for e.g. the Youtube player overlay controller. * * @param playbackTime The total overlay-managed playback duration, in seconds.

Declared In

APSMediaPlayerOverlayController.h

load

- (void)load
Discussion

This method is invoked by the player when first diplaying the overlay controller object.

Declared In

APSMediaPlayerOverlayController.h

loadState

- (MPMovieLoadState)loadState
Discussion

Allows an overlay controller to return a load state in place of the parent APSMediaUnit object, if the url property of that object is nil. See Apple’s documentation for more details about MPMovieLoadState.

This occurs for overlays that handle media playback in place of the parent unit, for e.g. the Youtube player overlay controller. * * @return The current overlay-managed load state.

Declared In

APSMediaPlayerOverlayController.h

movieSourceType

- (MPMovieSourceType)movieSourceType
Discussion

Allows an overlay controller to return a media source type in place of the parent APSMediaUnit object, if the url property of that object is nil. See Apple’s documentation for more details about MPMovieSourceType.

This occurs for overlays that handle media playback in place of the parent unit, for e.g. the Youtube player overlay controller. * * @return The current overlay-managed media source type.

Declared In

APSMediaPlayerOverlayController.h

onWebviewDismiss

- (APSWebviewDismissedAction)onWebviewDismiss
Discussion

Allows an overlay controller to specify what action the player should take when it comes back into focus, after a modal in-app web browser was triggered and dismissed by user interaction.

Return Value

The desired action. See APSWebviewDismissedAction for more details.

Declared In

APSMediaPlayerOverlayController.h

overlayWillBeRemoved

- (void)overlayWillBeRemoved
Discussion

This method is invoked by the player, before the overlay controller’s view is removed from the player surface. Any overlay cleanup code should be performed in this method.

The method is invoked on the main application thread.

Declared In

APSMediaPlayerOverlayController.h

pause

- (void)pause
Discussion

Allows an overlay that handles media playback in place of the parent unit to pause playback.

Declared In

APSMediaPlayerOverlayController.h

play

- (void)play
Discussion

Allows an overlay that handles media playback in place of the parent unit to start playback.

Declared In

APSMediaPlayerOverlayController.h

playableDuration

- (NSTimeInterval)playableDuration
Discussion

Allows an overlay controller to return a total playable (buffered) time in place of the parent APSMediaUnit object, if the url property of that object is nil.

This occurs for overlays that handle media playback in place of the parent unit, for e.g. the Youtube player overlay controller. * * @return The current overlay-managed total playable (buffered) time, in seconds.

Declared In

APSMediaPlayerOverlayController.h

playbackState

- (MPMoviePlaybackState)playbackState
Discussion

Allows an overlay controller to return a playback state in place of the parent APSMediaUnit object, if the url property of that object is nil. See Apple’s documentation for more details about MPMoviePlaybackState.

This occurs for overlays that handle media playback in place of the parent unit, for e.g. the Youtube player overlay controller. * * @return The current overlay-managed playback state.

Declared In

APSMediaPlayerOverlayController.h

preload

- (void)preload
Discussion

This method is invoked by the player on a background thread, before the overlay start point, as set by the [APSMediaEvent preTriggerInterval] property.

Declared In

APSMediaPlayerOverlayController.h

setCurrentPlaybackTime:

- (void)setCurrentPlaybackTime:(NSTimeInterval)playbackTime
Discussion

Allows an overlay that handles media playback in place of the parent unit to internally set the current playback time.

Parameters

playbackTime

The required playback time to seek to, in seconds.

Declared In

APSMediaPlayerOverlayController.h

stop

- (void)stop
Discussion

Allows an overlay that handles media playback in place of the parent unit to stop playback.

Declared In

APSMediaPlayerOverlayController.h

thumbnailImageAtTime:

- (UIImage *)thumbnailImageAtTime:(NSTimeInterval)time
Discussion

Allows an overlay that handles media playback in place of the parent unit to return a thumbnail image at a specific time interval from the managed video.

Parameters

time

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

Return Value

The resulting thumbnail.

Declared In

APSMediaPlayerOverlayController.h

update

- (void)update
Discussion

This method is called whenever the playback state of the player is changed (e.g. current playback time changes, playback state changes etc.). If the overlay controller needs to update its interface as a result of these changes, the updates should be performed in this method.

The method is invoked on the main application thread.

Declared In

APSMediaPlayerOverlayController.h

CocoaDocs.org - APSMediaPlayerProtocol Protocol Reference

VeesoPlayer2.0.28

Conforms to NSObject
Declared in APSMediaPlayerProtocol.h

Tasks

Accessing the APSAVPlayer's view

  •   view

    The container UIView of the player.

         property required method

Properties

  •   isPreparedToPlay

    Returns a Boolean value specifing if the player is ready to play media

         property required method
  •   initialPlaybackTime

    Get or set the initial time in stream from which the player will start playing the media

         property required method
  •   currentPlaybackTime

    Get or set the current position in stream

         property required method
  •   playableDuration

    Get the duration of the buffered content

         property required method
  •   duration

    Get the total duration of the video

         property required method
  •   currentPlaybackRate

    Get or set the current playback rate

         property required method
  •   contentURL

    Get or set the current media’s URL

         property required method
  •   scalingMode

    Get or set the scaling mode of the video according to its viewport

         property required method
  •   shouldAutoplay

    Get or set if the player should autoplay an URL as soon as it is provided

         property required method
  •   playbackState

    Get the current playback state

         property required method
  •   loadState

    Get the current state of the buffer

         property required method
  •   movieSourceType

    Get the current media’s source type (e.g. file or stream)

         property required method
  •   controlStyle

    Set or get how the player controls will appear

         property required method
  •   timedMetadata

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

         property required method
  •   allowsAirPlay

    Specifies whether the movie player allows AirPlay movie playback.

         property required method
  •   airPlayVideoActive

    Check out if AirPlay video is started or stopped.

         property required method

Required protocol methods

Optional protocol methods

Properties

airPlayVideoActive

@property (nonatomic, readonly) BOOL airPlayVideoActive
Discussion

Check out if AirPlay video is started or stopped.

Declared In

APSMediaPlayerProtocol.h

allowsAirPlay

@property (nonatomic) BOOL allowsAirPlay
Discussion

Specifies whether the movie player allows AirPlay movie playback.

Declared In

APSMediaPlayerProtocol.h

contentURL

@property (nonatomic, strong) NSURL *contentURL
Discussion

Get or set the current media’s URL

Declared In

APSMediaPlayerProtocol.h

controlStyle

@property (nonatomic) MPMovieControlStyle controlStyle
Discussion

Set or get how the player controls will appear

Declared In

APSMediaPlayerProtocol.h

currentPlaybackRate

@property (nonatomic) float currentPlaybackRate
Discussion

Get or set the current playback rate

Declared In

APSMediaPlayerProtocol.h

currentPlaybackTime

@property (nonatomic) NSTimeInterval currentPlaybackTime
Discussion

Get or set the current position in stream

Declared In

APSMediaPlayerProtocol.h

duration

@property (nonatomic, readonly) NSTimeInterval duration
Discussion

Get the total duration of the video

Declared In

APSMediaPlayerProtocol.h

initialPlaybackTime

@property (nonatomic) NSTimeInterval initialPlaybackTime
Discussion

Get or set the initial time in stream from which the player will start playing the media

Declared In

APSMediaPlayerProtocol.h

isPreparedToPlay

@property (nonatomic, readonly) BOOL isPreparedToPlay
Discussion

Returns a Boolean value specifing if the player is ready to play media

Declared In

APSMediaPlayerProtocol.h

loadState

@property (nonatomic, readonly) MPMovieLoadState loadState
Discussion

Get the current state of the buffer

Declared In

APSMediaPlayerProtocol.h

movieSourceType

@property (nonatomic) MPMovieSourceType movieSourceType
Discussion

Get the current media’s source type (e.g. file or stream)

Declared In

APSMediaPlayerProtocol.h

playableDuration

@property (nonatomic, readonly) NSTimeInterval playableDuration
Discussion

Get the duration of the buffered content

Declared In

APSMediaPlayerProtocol.h

playbackState

@property (nonatomic, readonly) MPMoviePlaybackState playbackState
Discussion

Get the current playback state

Declared In

APSMediaPlayerProtocol.h

scalingMode

@property (nonatomic) MPMovieScalingMode scalingMode
Discussion

Get or set the scaling mode of the video according to its viewport

Declared In

APSMediaPlayerProtocol.h

shouldAutoplay

@property (nonatomic) BOOL shouldAutoplay
Discussion

Get or set if the player should autoplay an URL as soon as it is provided

Declared In

APSMediaPlayerProtocol.h

timedMetadata

@property (nonatomic, readonly) NSArray *timedMetadata
Discussion

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

Returns an array of the most recent MPTimedMetadata objects provided by the media stream.

Declared In

APSMediaPlayerProtocol.h

view

@property (nonatomic, readonly) UIView *view
Discussion

The container UIView of the player.

Declared In

APSMediaPlayerProtocol.h

Class Methods

backendPriority

+ (NSInteger)backendPriority
Discussion

The priority based on which the backend will be selected

Declared In

APSMediaPlayerProtocol.h

Instance Methods

appendURL:

- (void)appendURL:(NSURL *)url
Discussion

Add an URL to the current play queue

Parameters

url

A NSURL instance pointing to the media location

Declared In

APSMediaPlayerProtocol.h

beginSeekingBackward

- (void)beginSeekingBackward
Discussion

Rewind the media

Declared In

APSMediaPlayerProtocol.h

beginSeekingForward

- (void)beginSeekingForward
Discussion

Play the media with an increased playback rate (speed)

Declared In

APSMediaPlayerProtocol.h

endSeeking

- (void)endSeeking
Discussion

Stop the seeking process startd by beginSeekingForward or beginSeekingBackward;

Declared In

APSMediaPlayerProtocol.h

getMute

- (BOOL)getMute
Discussion

Get if the player is muted or no

Return Value

The mute status

Declared In

APSMediaPlayerProtocol.h

getVolume

- (CGFloat)getVolume
Discussion

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

Return Value

The sound volume of the player

Declared In

APSMediaPlayerProtocol.h

initWithURLs:

- (id)initWithURLs:(NSArray *)urls
Discussion

Create a APSAVPlayer instance

Parameters

urls

A NSArray of NSURLs pointing to the media location

Return Value

The APSAVPlayer instance

Declared In

APSMediaPlayerProtocol.h

insertURL:atIndex:

- (void)insertURL:(NSURL *)url atIndex:(NSInteger)index
Discussion

Insert an URL to the current play queue at the given position

Parameters

url

A NSURL instance pointing to the media location

@param index

Declared In

APSMediaPlayerProtocol.h

pause

- (void)pause
Discussion

Pause the current playing media

Declared In

APSMediaPlayerProtocol.h

play

- (void)play
Discussion

Play the current media in the queue

Declared In

APSMediaPlayerProtocol.h

prepareToPlay

- (void)prepareToPlay
Discussion

Prepare to play media. This is also automatically called on play

Declared In

APSMediaPlayerProtocol.h

requestThumbnailImagesAtTimes:timeOption:

- (void)requestThumbnailImagesAtTimes:(NSArray *)playbackTimes timeOption:(MPMovieTimeOption)option
Discussion

Request a thumbnail image

Parameters

playbackTimes

A NSArray of NSTimeInterval, in seconds, when the thumbnail should be taken from the video

option

Precision

Return Value

The thumbnail image

Declared In

APSMediaPlayerProtocol.h

setMute:

- (void)setMute:(BOOL)mute
Discussion

Mute the player

Parameters

mute

BOOL set YES to mute or NO to unmute.

Declared In

APSMediaPlayerProtocol.h

setVolume:

- (void)setVolume:(CGFloat)volume
Discussion

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

Parameters

volume

CGFloat sound volume.

Declared In

APSMediaPlayerProtocol.h

stop

- (void)stop
Discussion

Stop the player, remove all the items from the queue and remove the player’s CALayer from its superlayer

Declared In

APSMediaPlayerProtocol.h

streamSourceType

- (APSMoviePlayerSourceType)streamSourceType
Discussion

Get the stream’s source type. Different by movieSourceType because it returns if the stream is a VOD stream or a live stream.

Return Value

The stream’s type as a APSMoviePlayerSourceType enum

Declared In

APSMediaPlayerProtocol.h

thumbnailAt:

- (UIImage *)thumbnailAt:(NSTimeInterval)playbackTime
Discussion

Request a thumbnail image

Parameters

playbackTime

The time, in seconds, when the thumbnail should be taken from the video

Return Value

The thumbnail image

Declared In

APSMediaPlayerProtocol.h

thumbnailImageAtTime:timeOption:

- (UIImage *)thumbnailImageAtTime:(NSTimeInterval)playbackTime timeOption:(MPMovieTimeOption)option
Discussion

Request a thumbnail image

Parameters

playbackTime

The time, in seconds, when the thumbnail should be taken from the video

option

Precision

Return Value

The thumbnail image

Declared In

APSMediaPlayerProtocol.h

CocoaDocs.org - APSMediaTrackableObject Protocol Reference

VeesoPlayer2.0.28

Conforms to NSObject
Declared in APSMediaTrackableObject.h

Overview

Defines the properties that an object needs to implement to become trackable by the player.

Tasks
  •   trackingURLs

    This dictionary defines all URLs that need to be notified of specific events from the object’s lifecycle. The keys are event constants, as defined in APSMediaPlayer, and the values are NSArrays containing NSURL objects.

         property required method

Properties

trackingURLs

@property (nonatomic) NSMutableDictionary *trackingURLs
Discussion

This dictionary defines all URLs that need to be notified of specific events from the object’s lifecycle. The keys are event constants, as defined in APSMediaPlayer, and the values are NSArrays containing NSURL objects.

Declared In

APSMediaTrackableObject.h

CocoaDocs.org - APSUnitManagerProtocol Protocol Reference

VeesoPlayer2.0.28

Conforms to KRAdapter
NSObject
Declared in APSUnitManagerProtocol.h

Overview

This protocol provides an interface for external objects that implement dynamic playback operations. Use this if you need to generate media URLs using timestamps or for implementing DRM support.

Tasks

Instance Methods

end

- (void)end
Discussion

When an APSMediaUnit ends playback, if it declares requiring a manager that matches the current object’s [KRAdapter type], this method will be invoked.

Declared In

APSUnitManagerProtocol.h

startForUnit:

- (void)startForUnit:(APSMediaUnit *)unit
Discussion

When an APSMediaUnit is loaded by the player, if it declares requiring a manager that matches the current object’s [KRAdapter type], this method will be invoked.

This method should handle playback by calling [APSMediaPlayer setCurrentURL:] to effectively start media playback for a specific URL, or call another relevant method (like [APSMediaPlayer step]) and generate APSMediaPlayerErrorNotification notifications on error.

Parameters

unit

The currently loading unit.

Declared In

APSUnitManagerProtocol.h

CocoaDocs.org - KRAdapter Protocol Reference

VeesoPlayer2.0.28

Conforms to NSObject
Declared in KRAdapter.h

Overview

The KRAdapter protocol allows an object to declare itself as being of a certain type.

Tasks
  • – type

    Returns the adapter type.

         required method

Instance Methods

type

- (NSString *)type
Discussion

Returns the adapter type.

Return Value

An adapter type in string format.

Declared In

KRAdapter.h

CocoaDocs.org - VeesoPlayer Hierarchy

VeesoPlayer2.0.28

CocoaDocs.org - VeesoPlayer Hierarchy

VeesoPlayer2.0.29

CocoaDocs.org - VeesoPlayer Reference

VeesoPlayer2.0.28

About

The Veeso Media Player allows you to:

  • Create playlists of synchronized videos and overlays
  • Configure a playlist from an external JSON file, an equivalent NSDictionary structure or directly via code attributes
  • Create custom, native overlays
  • Automatically configure ad linear inserts (pre, mid and post rolls) as well as nonlinear inserts (banner overlays), VAST 1.0, 2.0, 3.0 and VMAP 1.0 compliant
  • Create custom player skins, brand player with logo, insert overlay bugs, customize player controls
  • Track video and overlay lifecycle events in real-time, as rendered

Demo

Install cocoapods, and then run

pod try VeesoPlayer
+     CocoaDocs.org - VeesoPlayer Reference        
  
 
 
  
 
 
 
   
About
 
 
The Veeso Media Player allows you to:
 
     
  • Create playlists of synchronized videos and overlays
    •  
  • Configure a playlist from an external JSON file, an equivalent NSDictionary structure or directly via code attributes
    •  
  • Create custom, native overlays
    •  
  • Automatically configure ad linear inserts (pre, mid and post rolls) as well as nonlinear inserts (banner overlays), VAST 1.0, 2.0, 3.0 and VMAP 1.0 compliant
    •  
  • Create custom player skins, brand player with logo, insert overlay bugs, customize player controls
    •  
  • Track video and overlay lifecycle events in real-time, as rendered
    •  
 
Demo
 
Install cocoapods, and then run
 
pod try VeesoPlayer
 
 
Installation
 
There are currently two integration paths: via CocoaPods or via standard library download.
 
     
  1. Installing via CocoaPods (recommended)
    2.  
 
- Add the following line to your podfile:
 
         pod 'VeesoPlayer'
@@ -86,7 +86,7 @@
                 "drm_encoding_url": "http://url.to/marlin-broadband-key"
         }
 }
-
   
Class Reference
 
See the full class reference here.
 
Code Samples
 
See a showcase project featuring code samples for various playback scenarios here.
 
If you have CocoaPods installed, you can instantly see a demo of the Veeso player by typing pod try VeesoPlayer in your Terminal.
 
Requirements
 
APSMediaPlayer relies on the following liberally-licensed pods installed as dependencies:
  
Author
 
Appscend Video Solutions GmbH
 
License
 
Commercial license. Contact sales@veeso.co.
  
 
 
  
  
 
    CocoaDocs.org - VeesoPlayer Hierarchy       
  
 
 
    
 
    CocoaDocs.org - VeesoPlayer Hierarchy       
  
 
 
    
 
    CocoaDocs.org - VeesoPlayer Reference        
  
 
 
  
 
 
 
   
About
 
 
The Veeso Media Player allows you to:
 
     
  • Create playlists of synchronized videos and overlays
    •  
  • Configure a playlist from an external JSON file, an equivalent NSDictionary structure or directly via code attributes
    •  
  • Create custom, native overlays
    •  
  • Automatically configure ad linear inserts (pre, mid and post rolls) as well as nonlinear inserts (banner overlays), VAST 1.0, 2.0, 3.0 and VMAP 1.0 compliant
    •  
  • Create custom player skins, brand player with logo, insert overlay bugs, customize player controls
    •  
  • Track video and overlay lifecycle events in real-time, as rendered
    •  
 
Demo
 
Install cocoapods, and then run
 
pod try VeesoPlayer
+     CocoaDocs.org - VeesoPlayer Reference        
  
 
 
  
 
 
 
   
About
 
 
The Veeso Media Player allows you to:
 
     
  • Create playlists of synchronized videos and overlays
    •  
  • Configure a playlist from an external JSON file, an equivalent NSDictionary structure or directly via code attributes
    •  
  • Create custom, native overlays
    •  
  • Automatically configure ad linear inserts (pre, mid and post rolls) as well as nonlinear inserts (banner overlays), VAST 1.0, 2.0, 3.0 and VMAP 1.0 compliant
    •  
  • Create custom player skins, brand player with logo, insert overlay bugs, customize player controls
    •  
  • Track video and overlay lifecycle events in real-time, as rendered
    •  
 
Demo
 
Install cocoapods, and then run
 
pod try VeesoPlayer
 
 
Installation
 
There are currently two integration paths: via CocoaPods or via standard library download.
 
     
  1. Installing via CocoaPods (recommended)
    2.  
 
- Add the following line to your podfile:
 
         pod 'VeesoPlayer'
@@ -86,7 +86,7 @@
                 "drm_encoding_url": "http://url.to/marlin-broadband-key"
         }
 }
-
   
Class Reference
 
See the full class reference here.
 
Code Samples
 
See a showcase project featuring code samples for various playback scenarios here.
 
If you have CocoaPods installed, you can instantly see a demo of the Veeso player by typing pod try VeesoPlayer in your Terminal.
 
Requirements
 
APSMediaPlayer relies on the following liberally-licensed pods installed as dependencies:
  
Author
 
Appscend Video Solutions GmbH
 
License
 
Commercial license. Contact sales@veeso.co.