DorisPlayer Class Reference


                    
                    
                    currentAudioSessionRoute

audiosession route(airplay, headphones, builtInSpeaker, etc..)

Declaration

Swift

public var currentAudioSessionRoute: DorisAudioSessionRoute { get }


                    
                    
                    allowsPictureInPicturePlayback

If true will automatically transition to PIP mode when app is backgrounded and Phone settings have Start PiP Automatically set to true, default value is true

Note

This setting only works with custom UI, using with AVPlayerViewController has no effect

Declaration

Swift

public var allowsPictureInPicturePlayback: Bool { get set }


                    
                    
                    isMuted

mute player

Declaration

Swift

public var isMuted: Bool { get set }


                    
                    
                    resumeRate

resume rate to apple when play() is called

Declaration

Swift

public var resumeRate: Float


                    
                    
                    rate

playback rate

Declaration

Swift

public var rate: Float { get set }


                    
                    
                    volume

playback rate

Declaration

Swift

public var volume: Float { get set }


                    
                    
                    load(source:initialSeek:delay:autoStart:)

Replaces the current player item with the new one generated based on source data

Declaration

Swift

public func load(source: DorisSource, initialSeek: DorisSeekType? = nil, delay: Double? = nil, autoStart: Bool = true)

Parameters

`source`	source with .url, .item .csai .ssai type
`startAt`	seek position


                    
                    
                    unload(forcePlaybackFailure:)

Replaces the current player item with nil

Declaration

Swift

public func unload(forcePlaybackFailure: Bool = false)


                    
                    
                    play()

Begins playback of the current item

Declaration

Swift

public func play()


                    
                    
                    pause()

Pauses playback of the current item

Declaration

Swift

public func pause()


                    
                    
                    stop()

Stops playback of the current item then seeks to 0

Declaration

Swift

public func stop()


                    
                    
                    seek(_:callback:)

Sets the media current time to the specified position

Declaration

Swift

public func seek(_ type: DorisSeekType, callback: ((_ isCompleted: Bool) -> Void)? = nil)

Parameters


                                type

type of seek could be: date, position, offset


                    
                    
                    selectSubtitles(code:)

Select subtitles by its display name, returns true if current mediaSelection has changed after calling this method

Note

this method expects value returned by DorisPlayerOutputProtocol.onPlayerEvent(...) where event is DorisPlayerEvent.availableMediaSelectionLoaded(...)

Declaration

Swift

@discardableResult
public func selectSubtitles(code: String?) -> Bool

Parameters


                                code

ISO 639-2 language code of subtitle to select


                    
                    
                    selectAudioTrack(code:)

Select audio track by its display name, returns true if current mediaSelection has changed after calling this method

Note

this method expects value returned by DorisPlayerOutputProtocol.onPlayerEvent(...) where event is DorisPlayerEvent.availableMediaSelectionLoaded(...)

Declaration

Swift

@discardableResult
public func selectAudioTrack(code: String?) -> Bool

Parameters


                                code

ISO 639-2 language code of audio to select


                    
                    
                    selectSubtitles(title:)

Select subtitles by its display name, returns true if current mediaSelection has changed after calling this method

Note

this method expects value returned by DorisPlayerOutputProtocol.onPlayerEvent(...) where event is DorisPlayerEvent.availableMediaSelectionLoaded(...)

Declaration

Swift

@discardableResult
public func selectSubtitles(title: String?) -> Bool

Parameters


                                title

title specified in manifest file under NAME tag, or localized display name of language code


                    
                    
                    selectAudioTrack(title:)

Select audio track by its display name, returns true if current mediaSelection has changed after calling this method

Note

this method expects value returned by DorisPlayerOutputProtocol.onPlayerEvent(...) where event is DorisPlayerEvent.availableMediaSelectionLoaded(...)

Declaration

Swift

@discardableResult
public func selectAudioTrack(title: String?) -> Bool

Parameters


                                title

title specified in manifest file under NAME tag, or localized display name of language code


                    
                    
                    updateMetadata(_:)

Replaces the current item metadata and updates now playing info (lock screen controls)

Declaration

Swift

public func updateMetadata(_ metadata: DorisPlayerMediaMetadata)

Parameters


                                metadata

metadata to load


                    
                    
                    updateRemoteCommands(with:)

Configure MPRemoteCommandCenter

Declaration

Swift

public func updateRemoteCommands(with config: DorisRemoteCommandsConfig)

Parameters


                                config

Configuration for MPRemoteCommandCenter commands, enable/disable ones that you need


                    
                    
                    cancelDelayedLoad(type:)

If load(source:) was called with delay parameter, it can be canceled with this method

Declaration

Swift

public func cancelDelayedLoad(type: CancelationType)

Parameters


                                type

if CancelationType.cancel is passed previosly called load(source:) will be canceled if if CancelationType.loadInstantly is passed load(source:) will be called immidiatelly without delay


                    
                    
                    pauseClientSideAds()

Pauses Client side ads playback

Declaration

Swift

public func pauseClientSideAds()


                    
                    
                    resumeClientSideAds()

Resumes Client side ads playback

Declaration

Swift

public func resumeClientSideAds()


                    
                    
                    setLimitedSeekableRange(range:)

Limit Seekable Range for Live streams

Note

Should be set before DorisPlayerEvent.streamTypeRecognized(...) is called as it affects its outcome

Note

Set back to nil before loading new stream if you do not need Limited Seekable Range applied for that stream

Declaration

Swift

public func setLimitedSeekableRange(range: (start: Date?, end: Date?)?)

Parameters


                                range

if nil is specified, original range will be used, if range.end is specified LIVE stream will be considered as VOD


                    
                    
                    setPlaybackQuality(_:)

Select desired playback quality

Note

if connected to Cellular: Auto will switch between low and high based on system preferences Settings-> Mobile Data -> Mobile Data Options -> Low Data Mode

Note

if connected to WIFI: Auto will be same as High

Declaration

Swift

public func setPlaybackQuality(_ quality: DorisPlaybackQuality)

Parameters


                                quality

auto / low / high


                    
                    
                    replaceAdTagParameters(adTagParameters:validFrom:validUntil:)

Replace initial ad tag parameters

Note

this method does nothing if you have not includeed AVDorisPlugin.ima(...)plugin initially and if current source is not loaded with DorisPlayer.load(...)

Declaration

Swift

public func replaceAdTagParameters(adTagParameters: [String : Any], validFrom: Date?, validUntil: Date?)

Parameters

`adTagParameters`	Parameters to replace.
`validFrom`	Start date parameters are valid from.
`validUntil`	End date parameters are valid until. */


                    
                    
                    startMuxMonitoring(playerData:videoData:viewData:customData:shouldUpdate:)

Setup player monitoring with MUXSDK

Note

this method does nothing if you have not includeed AVDorisPlugin.mux(...)plugin initially

Declaration

Swift

public func startMuxMonitoring(playerData: DorisMuxCustomerPlayerData,
                               videoData: DorisMuxCustomerVideoData,
                               viewData: DorisMuxCustomerViewData? = nil,
                               customData: DorisMuxCustomData? = nil,
                               shouldUpdate: Bool = true)

Parameters

`playerData`	Player metadata
`videoData`	Video metadata */