Red5Pro IOS Client SDK

 10.0.0
Core SDK for IOS
R5AudioController Class Reference

Controller Object for R5Stream and R5Microphones. A shared instance is used unless otherwise defined on the object. More...

#import <R5AudioController.h>

Inherits NSObject.

Instance Methods

(instancetype) - initWithMode:
 
(double) - currentStreamTime
 

Class Methods

(R5AudioController *) + sharedInstance
 
(double) + getCurrentPubTime
 

Properties

BOOL isPlaying
 
BOOL isRecording
 
AudioUnitParameterValue pan
 
AudioUnitParameterValue volume
 

Detailed Description

Controller Object for R5Stream and R5Microphones. A shared instance is used unless otherwise defined on the object.

Method Documentation

◆ initWithMode:

- (instancetype) initWithMode: (R5AudioControllerMode)  mode

Initialize a new R5AudioController

Parameters
modeStandardIO or Echo Cancellation
Returns
an initialized R5AudioController

◆ sharedInstance

+ (R5AudioController *) sharedInstance

The static instance of a single R5AudioController. Controls all streams by default.

Returns
a single shared R5AudioController.

Property Documentation

◆ isPlaying

- (BOOL) isPlaying
readatomicassign

Is the R5AudioController currently playing an R5Stream.

◆ isRecording

- (BOOL) isRecording
readatomicassign

Is the R5AudioController currently recording to an R5Stream.

◆ pan

- (AudioUnitParameterValue) pan
readwritenonatomicassign

Pan (left/right) for audio playback. -1 to 1 value.

◆ volume

- (AudioUnitParameterValue) volume
readwritenonatomicassign

Adjusts the gain of the playback. 0 to 1 value.


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