Cluster Creator Kit Script Reference
    Preparing search index...

    Type Alias VoiceEncoderOptionPlayer

    Option values used with VoiceRecorderHandle.start. Specifies the encoder settings.

    type VoiceEncoderOption = {
        application?: "voip" | "audio";
        bitrate?: number;
        signal?: "music" | "voice";
    }
    Index

    Properties

    application?: "voip" | "audio"

    Sets the application type of the Opus encoder.
    The application type affects the quality of the encoded audio.

    If omitted, recording starts with an application type automatically determined by the system.

    bitrate?: number

    Sets the bitrate value of the Opus encoder in bits per second.
    The bitrate value affects the quality and data size of the encoded audio.

    The specified value is clamped to the range between 6000 and 96000.

    If omitted, recording starts with a bitrate value automatically determined by the system.

    signal?: "music" | "voice"

    Sets the signal type of the Opus encoder.
    The signal type affects the quality of the encoded audio.

    If omitted, recording starts with a signal type automatically determined by the system.