MCTrack Class Reference

Represents a captured instance of a media source. More...

#include <track.h>

Inheritance diagram for MCTrack:

Collaboration diagram for MCTrack:

Instance Methods
(NSString *)	- getId
(NSString *)	- kind
(BOOL)	- isEnabled
(void)	- enable:
(instancetype)	- initWithCppTrack: [implementation]
(instancetype)	- initWithSource:cppTrack: [implementation]

Properties
std::weak_ptr< millicast::Track >	cpp_track [implementation]
id	source [implementation]

Detailed Description

Represents a captured instance of a media source.

Method Documentation

enable:

- (void) enable:

(BOOL)

e

Enables or disables the track. A disabled audio track produces silence. A disabled video track produces black frames.

• Parameters:
  • e: True to enable the track, false otherwise.

getId

- (NSString *) getId

Get the track Id.

• Returns: The track ID.

initWithCppTrack:

- (instancetype) initWithCppTrack: (std::weak_ptr< millicast::Track >) track

implementation

initWithSource:cppTrack:

- (instancetype) initWithSource: (MCSource *) source cppTrack: (std::weak_ptr< millicast::Track >) track

implementation

isEnabled

- (BOOL) isEnabled

Checks whether the track is enabled or not.

• Returns: True if the track is enabled, false otherwise.

kind

- (NSString *) kind

Get the track type.

• Returns: The track type, either audio or video.

Property Documentation

cpp_track

- (weak_ptr<)millicast:

readwriteatomicimplementation

source

- (id) source

readwritenonatomicstrongimplementation

---

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

• objc/MillicastSDK/track.h