<OOMultiAudioProtocol > Protocol Reference

This protocol defines all the required methods to manage audio tracks and audio languages for OOOoyalaPlayer. More...

#import <OOMultiAudioProtocol.h>

+ Inheritance diagram for <OOMultiAudioProtocol >:

Instance Methods

(nonnull NSArray *) - availableAudioTracks
 Searchs for all of the audio tracks for the current asset. More...
 
(nullable id< OOAudioTrackProtocol >) - selectedAudioTrack
 Gets the currently selected (loaded) audio track. More...
 
(void) - setAudioTrack:
 Requests to change the current audio track to the one provided as a parameter. More...
 
(void) - setDefaultAudioTrack:
 Change the current default audio track to the one provided as a parameter. More...
 
(void) - setDefaultAudioTrackLanguageCode:
 Change the current default audio track language code to the one provided as a parameter. More...
 
(void) - setDefaultConfigAudioTrackLanguageCode:
 Change the current default audio track language code from config to the one provided as a parameter. More...
 
(nullable id< OOAudioTrackProtocol >) - defaultAudioTrack
 Gets the default audio track from manifest. More...
 

Detailed Description

This protocol defines all the required methods to manage audio tracks and audio languages for OOOoyalaPlayer.

Method Documentation

- (nonnull NSArray * OOMultiAudioProtocol) availableAudioTracks

Searchs for all of the audio tracks for the current asset.

It requires that a video has already loaded.

Returns
NSArray of OOAudioTrackProtocol objects. It could be empty if no audio tracks were found.
- (nullable id<OOAudioTrackProtocol> OOMultiAudioProtocol) defaultAudioTrack

Gets the default audio track from manifest.

Returns
An OOAudioTrackProtocol object or nil if nothing was found
- (nullable id<OOAudioTrackProtocol> OOMultiAudioProtocol) selectedAudioTrack

Gets the currently selected (loaded) audio track.

It requires that a video has already loaded.

Returns
An OOAudioTrackProtocol object or nil if nothing was found.
- (void OOMultiAudioProtocol) setAudioTrack: (nonnull id< OOAudioTrackProtocol >)  audioTrack

Requests to change the current audio track to the one provided as a parameter.

It requires that a video has already loaded.

Remarks
If the supplied OOAudioTrackProtocol isn't part of the current video asset nothing will happen.
Parameters
audioTrackOOAudioTrackProtocol to be used.
- (void OOMultiAudioProtocol) setDefaultAudioTrack: (nonnull id< OOAudioTrackProtocol >)  audioTrack

Change the current default audio track to the one provided as a parameter.

Remarks
This method doesn't change current playable audio track.
Parameters
audioTrackOOAudioTrackProtocol to be used.
- (void OOMultiAudioProtocol) setDefaultAudioTrackLanguageCode: (nonnull NSString *)  defaultAudioTrackLanguageCode

Change the current default audio track language code to the one provided as a parameter.

Parameters
defaultAudioTrackLanguageCodeLanguage code to be used.
- (void OOMultiAudioProtocol) setDefaultConfigAudioTrackLanguageCode: (nonnull NSString *)  defaultConfigAudioTrackLanguageCode

Change the current default audio track language code from config to the one provided as a parameter.

Parameters
defaultConfigAudioTrackLanguageCodeLanguage code to be used.

The documentation for this protocol was generated from the following file: