MillicastSDK 2.0.0
Loading...
Searching...
No Matches
Instance Methods | List of all members
MCRTSRemoteAudioTrack Class Reference

The RTS logical track's audio interface. More...

#import <rts_remote_track.h>

Inheritance diagram for MCRTSRemoteAudioTrack:
Inheritance graph
[legend]
Collaboration diagram for MCRTSRemoteAudioTrack:
Collaboration graph
[legend]

Instance Methods

(instancetype _Nonnull) - NS_UNAVAILABLE
 
(void) - enableWithCompletionHandler:
 
(void) - setVolume:completionHandler:
 
 __rtsRemoteAudioTrack
 
 initWithNativeTrack:
 
- Instance Methods inherited from MCRTSRemoteTrack
(MCRTSRemoteVideoTrack *_Nullable) - asVideo
 
(MCRTSRemoteAudioTrack *_Nullable) - asAudio
 
(instancetype _Nonnull) - NS_UNAVAILABLE
 
(void) - disableWithCompletionHandler:
 
 rtsRemoteTrackWithNativeTrack:
 

Additional Inherited Members

- Properties inherited from MCRTSRemoteTrack
id< MCRTSRemoteTrackDelegate > _Nullable delegate
 Delegate to receive track related events.
 
NSString *_Nullable sourceID
 The source ID of the track's publisher.
 
MCRemoteTrackKind kind
 Either an Audio or Video track.
 
BOOL isActive
 Whether the track is currently active.
 
NSString *_Nullable currentMID
 The current MID of the track. Useful to parse statistics based on the mid.
 

Detailed Description

The RTS logical track's audio interface.

Method Documentation

◆ enableWithCompletionHandler:

- (void) enableWithCompletionHandler: (nonnull void(^)(NSError *_Nullable))  completionHandler

Enable the audio track to start receiving media.

  • Parameters:
    • completionHandler: Handler invoked when the asynchronous operation completes.

◆ NS_UNAVAILABLE

- (instancetype _Nonnull) NS_UNAVAILABLE

Implements MCRTSRemoteTrack.

◆ setVolume:completionHandler:

- (void) setVolume: (double)  volume
completionHandler: (setVolume(_:completionHandler:))  NS_SWIFT_NAME 

Set audio volume

The volume will only be set if projected, and will be reset when unprojected.

  • Parameters:
    • volume: The volume in range 0.0 to 1.0
    • completionHandler: Invoked when the asynchronous operation completes.

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