IPlfApiSoundAudioDescription

General info

Constants

Outputs

int NoADRouting = 0

int MainSpeakers = 1

int HeadPhones = 2

int MonitorOut = 4

int SpdifOut = 8

Functions/Parameters

FResult IsVolumeControlSupported( int winid, Bool * retval )

Parameters

retval

Returns TRUE in the case that Audio Description (user) volume control is allowed within the current platform instance. FALSE is returned in case Audio Description (user) volume control is not allowed within the current platform instance

FResult IsVolumeControlAllowed( int winid, Bool * retval )

Parameters

retval

Returns TRUE in the case that Audio Description (user) volume control is allowed within the current use case. FALSE is returned in case Audio Description (user) volume control is not allowed within the current use-case

FResult GetVolumeMin( int winid, int * retval )

Parameters

retval

The minimum volume

FResult GetVolumeMax( int winid, int * retval )

Parameters

retval

The maximum volume

FResult SetVolume( int winid, int volume )

Notice that this volume setting affects the volume of the Audio Description stream only. This volume setting is applied on the Audio Description stream before being mixed with the main audio stream. "Normal" volume control of the various outputs (such as "main" and "headphone") is done after mixing.
Notice that this volume setting is linear.
This function shall only be called in the context of a use-case where the IsVolumeControlAllowed API function would return TRUE

Parameters

retval

The parameter volume specifies the volume level of the Audio Description stream before being mixed with the main audio stream. The value of the volume parameter must be in between GetVolumeMin and GetVolumeMax

FResult GetVolume( int winid, int * retval )

Parameters

retval

The actual volume level

FResult IsADRoutingSupported( int winid, Bool * retval )

Parameters

retval

Returns TRUE in the case that Audio Description routing is allowed within the current platform instance. FALSE is returned in case Audio Description routing is not allowed within the current platform instance

FResult IsADRoutingAllowed( int winid, Bool * retval )

Parameters

retval

Returns TRUE in the case that Audio Description routing is allowed within the current use-case. FALSE is returned in case Audio Description routing is not allowed within the current use-case

FResult SetADRouting( int winid, int outputs )

Parameters

outputs

The parameter outputs specifies on which outputs the Audio Description stream is to be mixed with the main audio stream. For this purpose, zero or more of the constants MainSpeakers, HeadPhones, MonitorOut (variable output level) and SpdifOut (comprises SPDIF, SCART and line-out (fixed output level)) can be OR-ed. The included outputs (constants) will have the Audio Description (once it is available), whereas the outputs that are not included will not have the Audio Description. In the case that routing for Audio Descriptor is no longer needed, then the constant NoADRouting shall be used as a parameter

FResult GetADRouting( int winid, int * retval )

Parameters

retval

Returns on which outputs the Audio Description stream will be mixed with the main audio stream. A logical AND operation with the constants MainSpeakers, HeadPhones, MonitorOut and SpdifOut can be done to obtain the result for a specific output. See also SetADRouting.