Shaka Player Embedded
Instance Methods | Protected Attributes | Properties | List of all members
ShakaTrack Class Reference

#import <track_objc.h>

Inheritance diagram for ShakaTrack:

Instance Methods

(instancetype) - initWithCpp: [implementation]
 
(const shaka::Track &) - toCpp [implementation]
 

Protected Attributes

shaka::Track value
 

Properties

double id
 
BOOL active
 
NSString * type
 
double bandwidth
 
NSString * language
 
NSString * label
 
NSString * kind
 
NSNumber * width
 
NSNumber * height
 
NSNumber * frameRate
 
NSString * mimeType
 
NSString * codecs
 
NSString * audioCodec
 
NSString * videoCodec
 
BOOL primary
 
NSArray< NSString * > * roles
 
NSNumber * videoId
 
NSNumber * audioId
 
NSNumber * channelsCount
 
NSNumber * audioBandwidth
 
NSNumber * videoBandwidth
 

Detailed Description

An object describing a media track. This object should be treated as read-only as changing any values does not have any effect. This is the public view of an audio/video paring (variant type) or text track (text type).

Definition at line 35 of file track_objc.h.

Method Documentation

§ initWithCpp:()

- (instancetype) initWithCpp: (const shaka::Track &)  obj
implementation

§ toCpp()

- (const Track& ShakaTrack()):
implementation

Member Data Documentation

§ value

- (Track ShakaTrack()):
protected

Definition at line 25 of file track+Internal.h.

Property Documentation

§ active

- (BOOL) active
readatomicassign

If true, this is the track being streamed (another track may be visible/audible in the buffer).

Definition at line 44 of file track_objc.h.

§ audioBandwidth

- (NSNumber *) audioBandwidth
readatomicassign

(only for variant tracks) The audio stream's bandwidth if known.

Definition at line 110 of file track_objc.h.

§ audioCodec

- (NSString *) audioCodec
readatomicassign

The audio codecs string provided in the manifest, if present.

Definition at line 83 of file track_objc.h.

§ audioId

- (NSNumber *) audioId
readatomicassign

(only for variant tracks) The audio stream id.

Definition at line 104 of file track_objc.h.

§ bandwidth

- (double) bandwidth
readatomicassign

The bandwidth required to play the track, in bits/sec.

Definition at line 50 of file track_objc.h.

§ channelsCount

- (NSNumber *) channelsCount
readatomicassign

The count of the audio track channels.

Definition at line 107 of file track_objc.h.

§ codecs

- (NSString *) codecs
readatomicassign

The audio/video codecs string provided in the manifest, if present.

Definition at line 80 of file track_objc.h.

§ frameRate

- (NSNumber *) frameRate
readatomicassign

The video framerate provided in the manifest, if present.

Definition at line 74 of file track_objc.h.

§ height

- (NSNumber *) height
readatomicassign

The video height provided in the manifest, if present.

Definition at line 71 of file track_objc.h.

§ id

- (double) id
readatomicassign

The unique ID of the track.

Definition at line 38 of file track_objc.h.

§ kind

- (NSString *) kind
readatomicassign

(only for text tracks) The kind of text track, either 'caption' or 'subtitle'.

Definition at line 65 of file track_objc.h.

§ label

- (NSString *) label
readatomicassign

The track label, which is unique text that should describe the track.

Definition at line 59 of file track_objc.h.

§ language

- (NSString *) language
readatomicassign

The language of the track, or 'und' if not given. This is the exact value provided in the manifest; it may need to be normalized.

Definition at line 56 of file track_objc.h.

§ mimeType

- (NSString *) mimeType
readatomicassign

The MIME type of the content provided in the manifest.

Definition at line 77 of file track_objc.h.

§ primary

- (BOOL) primary
readatomicassign

True indicates that this in the primary language for the content. This flag is based on signals from the manifest. This can be a useful hint about which language should be the default, and indicates which track Shaka will use when the user's language preference cannot be satisfied.

Definition at line 95 of file track_objc.h.

§ roles

- (NSArray< NSString * > *) roles
readatomicassign

The roles of the track, e.g. 'main', 'caption', or 'commentary'.

Definition at line 98 of file track_objc.h.

§ type

- (NSString *) type
readatomicassign

The type of track, either 'variant' or 'text'.

Definition at line 47 of file track_objc.h.

§ videoBandwidth

- (NSNumber *) videoBandwidth
readatomicassign

(only for variant tracks) The video stream's bandwidth if known.

Definition at line 113 of file track_objc.h.

§ videoCodec

- (NSString *) videoCodec
readatomicassign

The video codecs string provided in the manifest, if present.

Definition at line 86 of file track_objc.h.

§ videoId

- (NSNumber *) videoId
readatomicassign

(only for variant tracks) The video stream id.

Definition at line 101 of file track_objc.h.

§ width

- (NSNumber *) width
readatomicassign

The video width provided in the manifest, if present.

Definition at line 68 of file track_objc.h.


The documentation for this class was generated from the following files: