AudioMixerSettings

public struct AudioMixerSettings : Sendable

Constraints on the audio mixier settings.

  • The default value.

    Declaration

    Swift

    public static let `default`: AudioMixerSettings

  • Maximum sampleRate supported by the system

    Declaration

    Swift

    public static let maximumSampleRate: Float64

  • Specifies the sampleRate of audio output. A value of 0 will be the same as the main track source.

    Declaration

    Swift

    public let sampleRate: Float64

  • Specifies the channels of audio output. A value of 0 will be the same as the main track source.

    Warning

    If you are using IOStreamRecorder, please set it to 1 or 2. Otherwise, the audio will not be saved in local recordings.

    Declaration

    Swift

    public let channels: UInt32

  • Specifies the muted that indicates whether the audio output is muted.

    Declaration

    Swift

    public var isMuted: Bool

  • Specifies the main track number.

    Declaration

    Swift

    public var mainTrack: UInt8

  • Specifies the track settings.

    Declaration

    Swift

    public var tracks: [UInt8 : AudioMixerTrackSettings]

  • Specifies the maximum number of channels supported by the system

    • Description: The maximum number of channels to be used when the number of channels is 0 (not set). More than 2 channels are not supported by the service. It is defined to prevent audio issues since recording does not support more than 2 channels.

    Declaration

    Swift

    public var maximumNumberOfChannels: UInt32

  • Creates a new instance of a settings.

    Declaration

    Swift

    public init(
    sampleRate: Float64 = 0,
    channels: UInt32 = 0,
    isMuted: Bool = false,
    mainTrack: UInt8 = 0,
    tracks: [UInt8: AudioMixerTrackSettings] = .init()
)