IVSAudioConfiguration

Objective-C


@interface IVSAudioConfiguration : NSObject

Swift

class IVSAudioConfiguration : NSObject

A configuration object describing the desired format of the final output audio stream.

  • The audio bitrate for the output audio stream. By default this is 96,000.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSInteger bitrate;

    Swift

    var bitrate: Int { get }

  • Set the bitrate for the output audio stream. This must be greater than 64k and less than 160k. If the provided bitrate falls outside this range, bitrate will not be set and the provided outError will be set.

    Declaration

    Objective-C

    - (BOOL)setBitrate:(NSInteger)bitrate
             error:(NSError *_Nullable *_Nullable)outError;

    Swift

    func setBitrate(_ bitrate: Int) throws

    Parameters

    bitrate

    The average bitrate for the final output 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.

  • The number of channels for the output audio stream. By default this is 2.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSInteger channels;

    Swift

    var channels: Int { get }

  • Set the number of audio channels for the output stream. Currently this must be 1 or 2, otherwise the provided outError will be set.

    Declaration

    Objective-C

    - (BOOL)setChannels:(NSInteger)channels
              error:(NSError *_Nullable *_Nullable)outError;

    Swift

    func setChannels(_ channels: Int) throws

    Parameters

    channels

    the number of channels for the audio output 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.

  • The quality of the audio encoding

    Declaration

    Objective-C

    @property (nonatomic, readonly) IVSAudioQuality quality;

    Swift

    var quality: IVSBroadcastConfiguration.AudioQuality { get }