Plugin car.audiomixer

Members

AudioMixerSetting

Audio mixer settings enumeration

All values indicate a level within a range from 0 to 100%.

Properties:

Name	Type	Description
VOLUME	Number	The volume setting.
BASS	String	The bass setting.
MID	String	The midrange setting.
TREBLE	String	The treble setting.
BALANCE	Number	The balance setting.
FADE	String	The fade setting.

Methods

cancelWatch

Stop watching audio mixer changes

Parameters:

Name	Type	Description
watchId	Number	The watch ID returned by car.audiomixer.watchAudioMixer().

Example

car.audiomixer.cancelWatch(watchId);

get

Return the audio mixer settings for a specific zone

If successful, car.audiomixer.get() calls the successCallback function with the car.Zone object for the specific zone.

Parameters:

Name	Type	Argument	Description
successCallback	Function		The function to call with the result on success.
errorCallback	Function	<optional>	The function to call if there is an error.
zone	String	<optional>	The zone to filter the results by.

See:

• car.Zone

Examples

 

//define your callback function(s)
function successCallback(audioMixerItems) {
        //iterate through all the audio mixer items
        for (var i=0; <i REST - single zone

Request:
http://<car-ip>/car/audiomixer/get?zone=all

Response:
{
        code: 1,
        data: [
            { setting: 'volume', zone: 'all', value: 50 }
        ]
}

 REST - multi zone

Request:
http://<car-ip>/car/audiomixer/get

Success Response:
{
        code: 1,
        data: [
            { setting: 'volume', zone: 'all', value: 50 },
            { setting: 'bass', zone: 'all', value: 6 },
        ]
}

Error Response:
{
        code: -1,
        msg: "An error has occurred"
}

set

Save an audio mixer setting

Parameters:

Name	Type	Argument	Description
setting	String		A car.audiomixer.AudioMixerSetting value.
zone	String		A car.Zone value.
value	Number		The value to save.
successCallback	Function	<optional>	The function to call on success.
errorCallback	Function	<optional>	The function to call if there is an error.

See:

• car.audiomixer.AudioMixerSetting
• car.Zone

Examples

//option 1: Set the volume in the entire car to 50 using constants.
car.audiomixer.set(car.audiomixer.AudioMixerSetting.VOLUME, car.Zone.ALL, 50);

//option 2: Set the volume in the entire car to 50 without using constants.
car.audiomixer.set('volume', 'all', 50);

 REST

Request:
http://<car-ip>/car/audiomixer/set?setting=volume&zone=all&value=50

Success Response:
{
        code: 1
}

Error Response:
{
        code: -1,
        msg: "An error has occurred"
}

watchAudioMixer

Watch for audio mixer changes

Parameters:

Name	Type	Description
callback	Function	The function to call when a change is detected.

Returns:

An ID for the added watch.

Type

• String

Example

//define a callback function
function myCallback(audioMixerItems) {
        //iterate through the changed items
        for (var i=0; i<audioMixerItems.length; i++) {
            console.log("audio mixer item setting = " + audioMixerItems[i].setting + '\n' +    //a car.audiomixer.AudioMixerSetting value
                        "audio mixer item zone = " + audioMixerItems[i].zone + '\n' +        //a car.Zone value
                        "audio mixer item value = " + audioMixerItems[i].value + '\n\n');    //a numeric value
        }
}

var watchId = car.audiomixer.watchAudioMixer(myCallback);