IVSLocalStageStreamAudioConfiguration

Objective-C


@interface IVSLocalStageStreamAudioConfiguration : NSObject

Swift

class IVSLocalStageStreamAudioConfiguration : NSObject

A configuration object describing the desired format of the published audio track associated the IVSStageStream.

  • The max bitrate for the publishing audio stream. By default this is 64,000.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSInteger maxBitrate;

    Swift

    var maxBitrate: Int { get }

  • Sets the bitrate for the publishing audio stream. This value must be between 12k and 128k If the provided bitrate falls outside this range, bitrate will not be set and the provided outError will be set.

    Declaration

    Objective-C

    - (BOOL)setMaxBitrate:(NSInteger)maxBitrate
                error:(NSError *_Nullable *_Nullable)outError;

    Swift

    func setMaxBitrate(_ maxBitrate: Int) throws

    Parameters

    bitrate

    the bitrate for the publishing audio stream
    outError

    On input, a pointer to an error object. If an error occurs, the pointer is an NSError object that describes the error. If you don’t want error information, pass in nil.

    Return Value

    if the set operation is successful or not.

  • Setting this to YES will enable noise suppression.

    By default this is YES.

    Declaration

    Objective-C

    @property (nonatomic) BOOL enableNoiseSuppression;

    Swift

    var enableNoiseSuppression: Bool { get set }