com.webos.service.audiooutput

Note
This API has been available since API level 11.

API Summary

Connects the audio source to the audio output device and also controls the volume on the audio device. It provides HAL abstraction for the back-end, which means that the 'audiooutput' service works with HAL or ALSA or other hardware abstraction layer.

The 'audiooutput' service is a context-less (stateless) implementation of audio handling. Since the 'audio' service manages audio policies, the 'audiooutput' service will not hold any context information.

Note:

The service must only be used by the 'audio' service.
Application developers must not use the service directly.
[For webOS OSE Developers] Any modifications to the 'audiooutput' service can adversely effect the working of the 'audio' service.

Overview of the API

Methods

audio/connect

ACG: audiooutput.management

Added: API level 11

Description

Connects the audio source to the audio sink.

Parameters

Name	Required	Type	Description
source	Required	String	Indicates the audio source. Possible values are: AMIXER
sink	Required	String	Indicates the audio sink. Possible values are: ALSA

Name

Required

Type

Description

source

Required

String

Indicates the audio source. Possible values are:

AMIXER

sink

Required

String

Indicates the audio sink. Possible values are:

ALSA

Call Returns

Name	Required	Type	Description
returnValue	Required	Boolean	Indicates the status of the operation. Possible values are: true: Indicates that the operation was successful. false: Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details.
errorCode	Optional	Number (int8_t)	The error code for the failed operation.
errorText	Optional	String	Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.
source	Optional	String	Indicates the audio source.
sink	Optional	String	Indicates the audio sink.

Example

Example scenario

# luna-send -n 1 luna://com.webos.service.audiooutput/audio/connect '{
"source":"AMIXER",
"sink":"ALSA"
}'

Response:

{
   "source":"AMIXER",
   "sink":"ALSA",
   "returnValue":true
}

audio/disconnect

ACG: audiooutput.management

Added: API level 11

Description

Disconnects from the audio sink.

Note: No changes if there is no connection.

Parameters

Name	Required	Type	Description
source	Required	String	Indicates the audio source. Possible values are: AMIXER
sink	Required	String	Indicates the audio sink. Possible values are: ALSA

Name

Required

Type

Description

source

Required

String

Indicates the audio source. Possible values are:

AMIXER

sink

Required

String

Indicates the audio sink. Possible values are:

ALSA

Call Returns

Name	Required	Type	Description
returnValue	Required	Boolean	Indicates the status of the operation. Possible values are: true: Indicates that the operation was successful. false: Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details.
errorCode	Optional	Number (int8_t)	The error code for the failed operation.
errorText	Optional	String	Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.
source	Optional	String	Indicates the audio source.
sink	Optional	String	Indicates the audio sink.

Example

Example scenario

# luna-send -n 1 luna://com.webos.service.audiooutput/audio/disconnect '{"source":"AMIXER","sink":"ALSA"}'

Response:

{
   "source":"AMIXER",
   "sink":"ALSA",
   "returnValue":true
}

audio/getStatus

ACG: audiooutput.management

Added: API level 11

Description

Lists the information of all the connected audio source and sinks.

Parameters

None

Call Returns

Name	Required	Type	Description
returnValue	Required	Boolean	Indicates the status of the operation. Possible values are: true: Indicates that the operation was successful. false: Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details.
errorCode	Optional	Number (int8_t)	The error code for the failed operation.
errorText	Optional	String	Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.
audio	Optional	Object array: audio	Contains the connections between source and sink. Note: For definition of the object, click the link from the "Type" column.

Example

Example: When no source and sink are connected

# luna-send -n 1 -f luna://com.webos.service.audiooutput/audio/getStatus '{}'

Response:

{

"audio": [ ],
"returnValue": true

}

Example: When only source and sink are connected

# luna-send -n 1 -f luna://com.webos.service.audiooutput/audio/getStatus '{}'

Response:

{
   "audio":[
      {
         "source":"AMIXER",
         "sink":"ALSA",
         "muted":false,
         "outputMode":"null"
      }
   ],
   "returnValue":true
}

Example: When source, sink, and soundOut are connected

# luna-send -n 1 -f luna://com.webos.service.audiooutput/audio/getStatus '{}'

Response:

{
   "audio":[
      {
         "source":"AMIXER",
         "sink":"ALSA",
         "muted":false,
         "outputMode":"ALSA"
      }
   ],
   "returnValue":true
}

audio/mute

ACG: audiooutput.management

Added: API level 11

Description

Mutes or unmutes the connected audio source.

Parameters

Name	Required	Type	Description
source	Required	String	Indicates the audio source. Possible values are: AMIXER
sink	Required	String	Indicates the audio sink. Possible values are: ALSA
mute	Required	Boolean	Indicates if the audio source is to be muted. Possible values are: true: The audio source is muted. false: The audio source is not muted.

Name

Required

Type

Description

source

Required

String

Indicates the audio source. Possible values are:

AMIXER

sink

Required

String

Indicates the audio sink. Possible values are:

ALSA

mute

Required

Boolean

Indicates if the audio source is to be muted. Possible values are:

true: The audio source is muted.
false: The audio source is not muted.

Call Returns

Name	Required	Type	Description
returnValue	Required	Boolean	Indicates the status of the operation. Possible values are: true: Indicates that the operation was successful. false: Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details.
errorCode	Optional	Number (int8_t)	The error code for the failed operation.
errorText	Optional	String	Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.
source	Optional	String	Indicates the audio source.
sink	Optional	String	Indicates the audio sink.
mute	Optional	Boolean	Indicates if the audio source is muted. Possible values are: true: The audio source is muted. false: The audio source is not muted.

Example

Example scenario

# luna-send -n 1 -f luna://com.webos.service.audiooutput/audio/mute '{
   "sink":"ALSA",
   "source":"AMIXER",
   "mute":true
}'

Response:

{
   "source":"AMIXER",
   "sink":"ALSA",
   "mute":true,
   "returnValue":true
}

audio/setSoundOut

ACG: audiooutput.management

Added: API level 11

Description

Sets the audio output device to which the audio must be routed.

Parameters

Name	Required	Type	Description
soundOut	Required	String	Indicates the audio output device. Possible values are: ALSA

Name

Required

Type

Description

soundOut

Required

String

Indicates the audio output device. Possible values are:

ALSA

Call Returns

Name	Required	Type	Description
returnValue	Required	String	Indicates the status of the operation. Possible values are: true: Indicates that the operation was successful. false: Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details.
errorCode	Optional	Number (int8_t)	The error code for the failed operation.
errorText	Optional	String	Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.
soundOut	Optional	String	Indicates the audio output device.

Example

Example scenario

# luna-send -n 1 luna://com.webos.service.audiooutput/audio/setSoundOut '{"soundOut":"ALSA"}'

Response:

{
"soundOut":"ALSA",
"returnValue":true
}

audio/volume/down

ACG: audiooutput.management

Added: API level 11

Description

Linearly decreases, the master volume of the audio output device.

Parameters

Name	Required	Type	Description
soundOutput	Required	String	Indicates the audio output device. Possible values are: alsa

Name

Required

Type

Description

soundOutput

Required

String

Indicates the audio output device. Possible values are:

alsa

Call Returns

Name	Required	Type	Description
returnValue	Required	Boolean	Indicates the status of the operation. Possible values are: true: Indicates that the operation was successful. false: Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details.
errorCode	Optional	Number (int8_t)	The error code for the failed operation.
errorText	Optional	String	Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.
soundOutput	Optional	String	Indicates the audio output device.
volume	Optional	Number (int8_t)	Indicates the volume level after it is decreased. Possible range: 0 ~ 100

Example

Example scenario

# luna-send -n 1 luna://com.webos.service.audiooutput/audio/volume/down '{"soundOutput":"alsa"}'

Response:

{
   "soundOutput":"alsa",
   "volume":9,
   "returnValue":true
}

audio/volume/getStatus

ACG: audiooutput.management

Added: API level 11

Description

Lists the information of all available audio output devices.

Parameters

None

Call Returns

Name	Required	Type	Description
returnValue	Required	Boolean	Indicates the status of the operation. Possible values are: true: Indicates that the operation was successful. false: Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details.
errorCode	Optional	Number (int8_t)	The error code for the failed operation.
errorText	Optional	String	Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.
volumeStatus	Optional	Object array: volumeStatus	Contains the information of the audio output devices.

Example

Example scenario

# luna-send -n 1 luna://com.webos.service.audiooutput/audio/volume/getStatus '{}'

Response:

{
   "returnValue":true,
   "volumeStatus":[
      {
         "muted":false,
         "volume":10,
         "soundOutput":"ALSA"
      }
   ]
}

audio/volume/muteSoundOut

ACG: audiooutput.management

Added: API level 11

Description

Mutes the audio output device.

Parameters

Name	Required	Type	Description
soundOutput	Required	String	Indicates the audio output device. Possible values are: ALSA
mute	Required	Boolean	Indicates if the audio output device is to be muted. Possible values are: true: muted. false: not muted.

Name

Required

Type

Description

soundOutput

Required

String

Indicates the audio output device. Possible values are:

ALSA

mute

Required

Boolean

Indicates if the audio output device is to be muted.

Possible values are:

true: muted.
false: not muted.

Call Returns

Name	Required	Type	Description
returnValue	Required	Boolean	Indicates the status of the operation. Possible values are: true: Indicates that the operation was successful. false: Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details.
errorCode	Optional	Number (int8_t)	The error code for the failed operation
errorText	Optional	String	Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.
soundOutput	Optional	String	Indicates the audio output device.
mute	Optional	Boolean	Indicates if the audio output device is muted.

Example

Example scenario

# luna-send -n 1 luna://com.webos.service.audiooutput/audio/volume/muteSoundOut '{"soundOutput":"ALSA","mute":false}'

Response:

{
   "returnValue":true,
   "soundOutput":"ALSA",
   "mute":true
}

audio/volume/set

ACG: audiooutput.management

Added: API level 11

Description

Sets the volume of the audio output device, to a specific numerical value.

Parameters

Name	Required	Type	Description
soundOutput	Required	String	Indicates the audio output device. Possible values are: ALSA
volume	Required	Number (int8_t)	Indicates the volume level to be set. Possible range: 0 - 100

Name

Required

Type

Description

soundOutput

Required

String

Indicates the audio output device. Possible values are:

ALSA

volume

Required

Number (int8_t)

Indicates the volume level to be set.

Possible range: 0 - 100

Call Returns

Name	Required	Type	Description
returnValue	Required	Boolean	Indicates the status of the operation. Possible values are: true: Indicates that the operation was successful. false: Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details.
errorCode	Optional	Number (int8_t)	The error code for the failed operation.
errorText	Optional	String	Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.
soundOutput	Optional	String	Indicates the audio output device.
volume	Optional	Number (int8_t)	Indicates the volume level to be set. Possible range: 0 - 100

Example

Example scenario

# luna-send -n 1 luna://com.webos.service.audiooutput/audio/volume/set '{"soundOutput":"ALSA","volume":10}'

Response:

{
   "soundOutput":"ALSA",
   "volume":10,
   "returnValue":true
}

audio/volume/up

ACG: audiooutput.management

Added: API level 11

Description

Linearly increases, the master volume of the audio output device.

Parameters

Name	Required	Type	Description
soundOutput	Required	String	Indicates the audio output device. Possible values are: ALSA

Name

Required

Type

Description

soundOutput

Required

String

Indicates the audio output device. Possible values are:

ALSA

Call Returns

Name	Required	Type	Description
returnValue	Required	Boolean	Indicates the status of the operation. Possible values are: true: Indicates that the operation was successful. false: Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details.
errorCode	Optional	Number (int8_t)	The error code for the failed operation.
errorText	Optional	String	Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.
soundOutput	Optional	String	Indicates the audio output device.
volume	Optional	Number (int8_t)	Indicates the volume level after it is increased. Possible range: 0 ~ 100

Example

Example scenario

# luna-send -n 1 luna://com.webos.service.audiooutput/audio/volume/up '{"soundOutput":"ALSA"}'

Response:

{
   "soundOutput":"ALSA",
   "volume":11,
   "returnValue":true
}

Objects

audio

Contains information of the connections between source and sink.

Note: If no Source/Sink are connected, it returns an empty array.

Name	Required	Type	Description
source	Optional	String	Indicates the audio source. Note: Returns empty string if no source and sink are connected. Possible values are: AMIXER
sink	Optional	String	Indicates the audio sink. Note: Returns empty string if no source and sink are connected. Possible values are: ALSA
muted	Optional	Boolean	Indicates if the audio is muted. Possible values are: true: audio is muted. false: audio is not muted.
outputMode	Optional	String	Indicates the audio output device. Note: Returns "null" string if no output device is set. Possible values are: ALSA

volumeStatus

Contains the information of the audio output devices.

Name	Required	Type	Description
muted	Required	Boolean	Indicates if the audio output device is muted. Possible values are: true: muted. false: not muted.
volume	Required	Number (int8_t)	Indicates the volume level of the audio output device. Possible volume range: 0 - 100
soundOutput	Required	String	Indicates the audio output device. Possible values are: ALSA

Name

Required

Type

Description

muted

Required

Boolean

Indicates if the audio output device is muted.

Possible values are:

true: muted.
false: not muted.

volume

Required

Number (int8_t)

Indicates the volume level of the audio output device.

Possible volume range: 0 - 100

soundOutput

Required

String

Indicates the audio output device.

Possible values are:

ALSA

API Error Codes Reference

Error Code	Error Text	Error Description
1	Unknown error	General Service error: API_ERROR_UNKNOWN 1 "Unknown error"
3	Failed to validate against schema	General Service error: API_ERROR_SCHEMA_VALIDATION 3 "Failed to validate against schema"
4	Invalid Parameters	General Service error: API_ERROR_INVALID_PARAMETERS 4 "invalid input Parameters"
10	Not implemented	General Service error: API_ERROR_NOT_IMPLEMENTED 10 "Functionality not implemented
20	Driver error while executing the command	Driver error: API_ERROR_HAL_ERROR 20 "Driver error while executing the command"
200	Audio not connected	Audio error: API_ERROR_AUDIO_NOT_CONNECTED 200 "Audio not connected"
201	soundOutput not implemented	Audio error: API_ERROR_INVALID_SPKTYPE 201, "soundOutput not implemented”
202	Volume already at max/min/Volume out of range	Audio error: API_ERROR_VOLUME_LIMIT 202, “Volume already at max/min”/"Volume out of range"
203	Connection not possible	Audio error: API_ERROR_CONNECTION_NOT_POSSIBLE 203 "Connection not possible"
204	Volume control is not supported	Volume control error: API_ERROR_INVALID_VOLUME_CONTROL 204," Volume control is not supported"