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

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

#import <webrtc_remote_track.h>

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

Instance Methods

(void) - projectWithRTSRemoteAudioTrack:completionHandler:
 
(void) - setVolume:completionHandler:
 
(void) - currentProjectionWithCompletionHandler:
 
- Instance Methods inherited from MCWebrtcRemoteTrack
(MCWebrtcRemoteAudioTrack *_Nullable) - asAudio
 
(MCWebrtcRemoteVideoTrack *_Nullable) - asVideo
 
(void) - unprojectWithCompletionHandler:
 
 webrtcRemoteTrackWithNativeTrack:
 

Additional Inherited Members

- Properties inherited from MCWebrtcRemoteTrack
id< MCWebrtcRemoteTrackDelegate > _Nullable delegate
 Delegate to receive track related events.
 
MCRemoteTrackKind kind
 Either an Audio or Video track.
 
NSString *_Nonnull currentMID
 
NSString *_Nonnull cName
 The cname of the track. Cname represents a grouping for synchronization purposes.
 

Detailed Description

The webrtc logical track's audio interface.

Method Documentation

◆ currentProjectionWithCompletionHandler:

- (void) currentProjectionWithCompletionHandler: (nonnull void(^)(MCRTSRemoteAudioTrack *_Nullable, NSError *_Nullable))  completionHandler

◆ projectWithRTSRemoteAudioTrack:completionHandler:

- (void) projectWithRTSRemoteAudioTrack: (MCRTSRemoteAudioTrack *_Nonnull)  rtsRemoteAudioTrack
completionHandler: (project(rtsRemoteAudioTrack:completionHandler:))  NS_SWIFT_NAME 

Enable the track and project from given RTS track.

Note that unlike the simple API for the RTS track, this API is more flexible, but requires more handling by the application. Specifically, the track will not be unprojected automatically when the RTS track goes inactive (and will not require repeating project operation when it goes active again)

You can project the same RTS track onto multiple webrtc logical tracks.

  • Parameters:
    • rtsRemoteAudioTrack: the RTS track which will be projected onto this webrtc track.
    • completionHandler: Invoked when the asynchronous operation completes.

◆ 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: