AudioInput

Outgoing Messages

StopAudioInput

Notifies the platform implementation to stop writing audio samples to the Engine.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "AudioInput",
            "action": "StopAudioInput"
        }
    },
    "payload": {
        "streamId": {{String}}        
    }
}

Payload

Property	Type	Required	Description	Example
streamId	String	Yes	Stream ID that is used to write audio data to.	4f52d5a6-2b36-4723-93d5-4e569be99961

StartAudioInput

Notifies the platform implementation to start writing audio samples to the Engine.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "AudioInput",
            "action": "StartAudioInput"
        }
    },
    "payload": {
        "name": {{String}},
        "audioType": {{AudioInputAudioType}},
        "streamId": {{String}}        
    }
}

Payload

Property	Type	Required	Description	Example
name	String	Yes	Name of the Engine component that is requesting audio.
audioType	AudioInputAudioType	Yes	The type of audio data being requested.
streamId	String	Yes	Stream ID that is used to write audio data to.

Enums

AudioInputAudioType

Values

Value	Description
"VOICE"	Voice audio type.
"COMMUNICATION"	Communication audio type.
"LOOPBACK"	Loopback audio type.