 |
LiveSwitch iOS/macOS API Reference Documentation
|
|
LiveSwitch iOS/macOS API Reference Documentation
|
A collection of audio/video track base methods/properties. More...
Instance Methods | |
| (void) | - addOnAudioLevel: |
| Adds a handler that is raised periodically when the audio's level is calculated. More... | |
| (double) | - addOnAudioLevelWithBlock |
| Adds a handler that is raised periodically when the audio's level is calculated. More... | |
| (void) | - addOnAudioLevelWithBlock: |
| Adds a handler that is raised periodically when the audio's level is calculated. More... | |
| (void) | - addOnVideoDestroyed: |
| Adds a handler that is raised when the video track is destroyed. More... | |
| (void) | - addOnVideoSize: |
| Adds a handler that is raised whenever the video's frame size is known, once per frame. More... | |
| (void) | - addOnVideoSizeChange: |
| Adds a handler that is raised whenever the video's frame size changes. More... | |
| (FMLiveSwitchSize *) | - addOnVideoSizeChangeWithBlock |
| Adds a handler that is raised whenever the video's frame size changes. More... | |
| (void) | - addOnVideoSizeChangeWithBlock: |
| Adds a handler that is raised whenever the video's frame size changes. More... | |
| (FMLiveSwitchSize *) | - addOnVideoSizeWithBlock |
| Adds a handler that is raised whenever the video's frame size is known, once per frame. More... | |
| (void) | - addOnVideoSizeWithBlock: |
| Adds a handler that is raised whenever the video's frame size is known, once per frame. More... | |
| (double) | - audioGain |
| Gets the gain (input amplification) of the audio track. More... | |
| (int) | - audioLevelInterval |
| Gets the interval in milliseconds between FMLiveSwitchMediaBase`2addOnAudioLevel: events. More... | |
| (bool) | - audioMuted |
| Gets a value indicating whether the audio is muted. More... | |
| (TIAudioTrack) | - audioTrack |
| Gets the audio track from this media. More... | |
| (NSMutableArray *) | - audioTracks |
| Gets all audio tracks from this media. More... | |
| (double) | - audioVolume |
| Gets the audio volume on the audio track. More... | |
| (void) | - destroy |
| Destroys this media stack. More... | |
| (FMLiveSwitchFuture< FMLiveSwitchVideoBuffer * > *) | - grabVideoFrame |
| Gets the next raw video frame. More... | |
| (NSString *) | - id |
| Gets the unique identifier of this media. More... | |
| (instancetype) | - init |
| Initializes a new instance of the FMLiveSwitchMediaBase`2 class. More... | |
| (void) | - removeOnAudioDestroyed: |
| Removes a handler that is raised when the audio track is destroyed. More... | |
| (void) | - removeOnAudioLevel: |
| Removes a handler that is raised periodically when the audio's level is calculated. More... | |
| (void) | - removeOnVideoDestroyed: |
| Removes a handler that is raised when the video track is destroyed. More... | |
| (void) | - removeOnVideoSize: |
| Removes a handler that is raised whenever the video's frame size is known, once per frame. More... | |
| (void) | - removeOnVideoSizeChange: |
| Removes a handler that is raised whenever the video's frame size changes. More... | |
| (void) | - setAudioGain: |
| Sets the gain (input amplification) of the audio track. More... | |
| (void) | - setAudioLevelInterval: |
| Sets the interval in milliseconds between FMLiveSwitchMediaBase`2addOnAudioLevel: events. More... | |
| (void) | - setAudioMuted: |
| Sets a value indicating whether the audio is muted. More... | |
| (void) | - setAudioVolume: |
| Sets the audio volume on the audio track. More... | |
| (void) | - setId: |
| Sets the unique identifier of this media. More... | |
| (void) | - setVideoMuted: |
| Sets a value indicating whether the video track is muted. More... | |
| (bool) | - videoMuted |
| Gets a value indicating whether the video track is muted. More... | |
| (FMLiveSwitchSize *) | - videoSize |
| Gets the size of the last processed video frame, if known. More... | |
| (TIVideoTrack) | - videoTrack |
| Gets the video track from this media. More... | |
| (NSMutableArray *) | - videoTracks |
| Gets all video tracks from this media. More... | |
Class Methods | |
| (FMLiveSwitchMediaBase *) | + mediaBase |
| Initializes a new instance of the FMLiveSwitchMediaBase`2 class. More... | |
Protected Attributes | |
| __pad0__: FMLiveSwitchDynamic<FMLiveSwitchIMedia>- (void) addOnAudioDestroyed:(FMLiveSwitchAction0*)value | |
A collection of audio/video track base methods/properties.
| - (void) addOnAudioLevel: | (FMLiveSwitchAction1< id > *) | value |
Adds a handler that is raised periodically when the audio's level is calculated.
If there are multiple audio tracks in a custom media stack, this event is only triggered by the first audio track.
| - (double) addOnAudioLevelWithBlock |
Adds a handler that is raised periodically when the audio's level is calculated.
If there are multiple audio tracks in a custom media stack, this event is only triggered by the first audio track.
| - (void) addOnAudioLevelWithBlock: | (void(^)(double)) | valueBlock |
Adds a handler that is raised periodically when the audio's level is calculated.
If there are multiple audio tracks in a custom media stack, this event is only triggered by the first audio track.
| - (void) addOnVideoDestroyed: | (FMLiveSwitchAction0 *) | value |
Adds a handler that is raised when the video track is destroyed.
If there are multiple video tracks in a custom media stack, this event is only triggered by the first video track.
| - (void) addOnVideoSize: | (FMLiveSwitchAction1< FMLiveSwitchSize * > *) | value |
Adds a handler that is raised whenever the video's frame size is known, once per frame.
If there are multiple video tracks in a custom media stack, this event is only triggered by the first video track.
| - (void) addOnVideoSizeChange: | (FMLiveSwitchAction1< FMLiveSwitchSize * > *) | value |
Adds a handler that is raised whenever the video's frame size changes.
If there are multiple video tracks in a custom media stack, this event is only triggered by the first video track.
| - (FMLiveSwitchSize*) addOnVideoSizeChangeWithBlock |
Adds a handler that is raised whenever the video's frame size changes.
If there are multiple video tracks in a custom media stack, this event is only triggered by the first video track.
| - (void) addOnVideoSizeChangeWithBlock: | (void(^)(FMLiveSwitchSize *)) | valueBlock |
Adds a handler that is raised whenever the video's frame size changes.
If there are multiple video tracks in a custom media stack, this event is only triggered by the first video track.
| - (FMLiveSwitchSize*) addOnVideoSizeWithBlock |
Adds a handler that is raised whenever the video's frame size is known, once per frame.
If there are multiple video tracks in a custom media stack, this event is only triggered by the first video track.
| - (void) addOnVideoSizeWithBlock: | (void(^)(FMLiveSwitchSize *)) | valueBlock |
Adds a handler that is raised whenever the video's frame size is known, once per frame.
If there are multiple video tracks in a custom media stack, this event is only triggered by the first video track.
| - (double) audioGain |
Gets the gain (input amplification) of the audio track.
Any value greater than or equal to 0.0 is valid. The default value is 1. If there are multiple audio tracks in a custom media stack, this property is bound to the first audio track.
| - (int) audioLevelInterval |
Gets the interval in milliseconds between FMLiveSwitchMediaBase`2addOnAudioLevel: events.
| - (bool) audioMuted |
Gets a value indicating whether the audio is muted.
This method silences audio but does not disable the audio source or prevent its data from flowing through the processing pipeline. If there are multiple audio tracks in a custom media stack, this property is bound to the first audio track.
| - (TIAudioTrack) audioTrack |
Gets the audio track from this media.
If there are multiple audio tracks in a custom media stack, this property is bound to the first audio track. Returns null if there are no audio tracks.
| - (NSMutableArray*) audioTracks |
Gets all audio tracks from this media.
| - (double) audioVolume |
Gets the audio volume on the audio track.
Valid values range between 0.0 and 1.0. A value of 1.0 indicates that there is no output resistance on the audio and it is played back at the input level. A value of 0.0 mutes the audio.
If there are multiple audio tracks in a custom media stack, this property is bound to the first audio track.
| - (void) destroy |
Destroys this media stack.
| - (FMLiveSwitchFuture<FMLiveSwitchVideoBuffer*>*) grabVideoFrame |
Gets the next raw video frame.
If there are multiple video tracks in a custom media stack, this method calls into the first video track.
| - (instancetype) init |
Initializes a new instance of the FMLiveSwitchMediaBase`2 class.
| + (FMLiveSwitchMediaBase*) mediaBase |
Initializes a new instance of the FMLiveSwitchMediaBase`2 class.
| - (void) removeOnAudioDestroyed: | (FMLiveSwitchAction0 *) | value |
Removes a handler that is raised when the audio track is destroyed.
If there are multiple audio tracks in a custom media stack, this event is only triggered by the first audio track.
| - (void) removeOnAudioLevel: | (FMLiveSwitchAction1< id > *) | value |
Removes a handler that is raised periodically when the audio's level is calculated.
If there are multiple audio tracks in a custom media stack, this event is only triggered by the first audio track.
| - (void) removeOnVideoDestroyed: | (FMLiveSwitchAction0 *) | value |
Removes a handler that is raised when the video track is destroyed.
If there are multiple video tracks in a custom media stack, this event is only triggered by the first video track.
| - (void) removeOnVideoSize: | (FMLiveSwitchAction1< FMLiveSwitchSize * > *) | value |
Removes a handler that is raised whenever the video's frame size is known, once per frame.
If there are multiple video tracks in a custom media stack, this event is only triggered by the first video track.
| - (void) removeOnVideoSizeChange: | (FMLiveSwitchAction1< FMLiveSwitchSize * > *) | value |
Removes a handler that is raised whenever the video's frame size changes.
If there are multiple video tracks in a custom media stack, this event is only triggered by the first video track.
| - (void) setAudioGain: | (double) | value |
Sets the gain (input amplification) of the audio track.
Any value greater than or equal to 0.0 is valid. The default value is 1. If there are multiple audio tracks in a custom media stack, this property is bound to the first audio track.
| - (void) setAudioLevelInterval: | (int) | value |
Sets the interval in milliseconds between FMLiveSwitchMediaBase`2addOnAudioLevel: events.
| - (void) setAudioMuted: | (bool) | value |
Sets a value indicating whether the audio is muted.
This method silences audio but does not disable the audio source or prevent its data from flowing through the processing pipeline. If there are multiple audio tracks in a custom media stack, this property is bound to the first audio track.
| - (void) setAudioVolume: | (double) | value |
Sets the audio volume on the audio track.
Valid values range between 0.0 and 1.0. A value of 1.0 indicates that there is no output resistance on the audio and it is played back at the input level. A value of 0.0 mutes the audio.
If there are multiple audio tracks in a custom media stack, this property is bound to the first audio track.
| - (void) setId: | (NSString *) | value |
Sets the unique identifier of this media.
| - (void) setVideoMuted: | (bool) | value |
Sets a value indicating whether the video track is muted.
If the video track is muted, then remote users see a black frame instead of the local user’s video.
If there are multiple video tracks in a custom media stack, this property is bound to the first video track.
| - (bool) videoMuted |
Gets a value indicating whether the video track is muted.
If the video track is muted, then remote users see a black frame instead of the local user’s video.
If there are multiple video tracks in a custom media stack, this property is bound to the first video track.
| - (FMLiveSwitchSize*) videoSize |
Gets the size of the last processed video frame, if known.
If there are multiple video tracks in a custom media stack, this property is bound to the first video track.
| - (TIVideoTrack) videoTrack |
Gets the video track from this media.
If there are multiple video tracks in a custom media stack, this property is bound to the first video track. Returns null if there are no video tracks.
| - (NSMutableArray*) videoTracks |
Gets all video tracks from this media.
|
protected |