Description

Described herein are the DeviceSettings HAL types and functions that are part of the Audio subsystem. The Audio subsystem manages audio hardware operations.

Functions
dsError_t	dsAudioPortInit ()
	Initialize the underlying Audio Port sub-system. More...

dsError_t	dsGetAudioPort (dsAudioPortType_t type, int index, intptr_t *handle)
	Get the audio port handle. More...

dsError_t	dsGetAudioEncoding (intptr_t handle, dsAudioEncoding_t *encoding)
	Get the encoding type of an audio port. More...

dsError_t	dsGetAudioFormat (intptr_t handle, dsAudioFormat_t *audioFormat)
	Get the current audio format. More...

dsError_t	dsGetAudioCompression (intptr_t handle, int *compression)
	Get the audio compressionof an audio port. More...

dsError_t	dsGetDialogEnhancement (intptr_t handle, int *level)
	Get the Dialog Enhancement level of an audio port. More...

dsError_t	dsGetDolbyVolumeMode (intptr_t handle, bool *mode)
	Get the dolby audio mode status. More...

dsError_t	dsGetIntelligentEqualizerMode (intptr_t handle, int *mode)
	Get the Intelligent Equalizer Mode. More...

dsError_t	dsGetVolumeLeveller (intptr_t handle, dsVolumeLeveller_t *volLeveller)
	To get the Dolby volume leveller. More...

dsError_t	dsGetBassEnhancer (intptr_t handle, int *boost)
	To get the audio Bass. More...

dsError_t	dsIsSurroundDecoderEnabled (intptr_t handle, bool *enabled)
	To get the audio Surround Decoder. More...

dsError_t	dsGetDRCMode (intptr_t handle, int *mode)
	To get the DRC Mode. More...

dsError_t	dsGetSurroundVirtualizer (intptr_t handle, dsSurroundVirtualizer_t *virtualizer)
	To get the audio Surround Virtualizer level. More...

dsError_t	dsGetMISteering (intptr_t handle, bool *enabled)
	To get the audio Media intelligent Steering. More...

dsError_t	dsGetGraphicEqualizerMode (intptr_t handle, int *mode)
	Get the Graphic Equalizer Mode. More...

dsError_t	dsGetMS12AudioProfileList (intptr_t handle, dsMS12AudioProfileList_t *profiles)
	To get the supported MS12 audio profiles. More...

dsError_t	dsGetMS12AudioProfile (intptr_t handle, char *profile)
	To get current audio profile selection. More...

dsError_t	dsGetSupportedARCTypes (intptr_t handle, int *types)
	Get the supported ARC types of the connected ARC/eARC device. More...

dsError_t	dsAudioSetSAD (intptr_t handle, dsAudioSADList_t sad_list)
	Set Short Audio Descriptor retrieved from CEC for the connected ARC device. More...

dsError_t	dsAudioEnableARC (intptr_t handle, dsAudioARCStatus_t arcStatus)
	enable/disable ARC/EARC and route audio to connected device More...

dsError_t	dsGetStereoMode (intptr_t handle, dsAudioStereoMode_t *stereoMode)
	Get the stereo mode of an audio port. More...

dsError_t	dsGetStereoAuto (intptr_t handle, int *autoMode)
	This function is used to get the current auto mode setting of the specified audio port. More...

dsError_t	dsGetAudioGain (intptr_t handle, float *gain)
	Get the audio gain of an audio port. More...

dsError_t	dsGetAudioDB (intptr_t handle, float *db)
	Get the current audio dB level of an audio port. More...

dsError_t	dsGetAudioLevel (intptr_t handle, float *level)
	Get the current audio volume level of an audio port. More...

dsError_t	dsGetAudioMaxDB (intptr_t handle, float *maxDb)
	Get the maximum audio dB level of an audio port. More...

dsError_t	dsGetAudioMinDB (intptr_t handle, float *minDb)
	Get the minimum audio dB level of an audio port. More...

dsError_t	dsGetAudioOptimalLevel (intptr_t handle, float *optimalLevel)
	Get the optimal audio level of an audio port. More...

dsError_t	dsGetAudioDelay (intptr_t handle, uint32_t *audioDelayMs)
	Get the audio delay in milliseconds. More...

dsError_t	dsGetAudioDelayOffset (intptr_t handle, uint32_t *audioDelayOffsetMs)
	Get the audio delay offset in milliseconds. More...

dsError_t	dsSetAudioAtmosOutputMode (intptr_t handle, bool enable)
	Set the audio ATMOS outout mode. More...

dsError_t	dsGetSinkDeviceAtmosCapability (intptr_t handle, dsATMOSCapability_t *capability)
	Get the sink device ATMOS capability. More...

dsError_t	dsIsAudioLoopThru (intptr_t handle, bool *loopThru)
	Get the loop-through mode of an audio port. More...

dsError_t	dsIsAudioMute (intptr_t handle, bool *muted)
	Get the audio mute status of an audio port. More...

dsError_t	dsIsAudioPortEnabled (intptr_t handle, bool *enabled)
	This function indicates whether the specified Audio port is enabled or not. More...

dsError_t	dsEnableAudioPort (intptr_t handle, bool enabled)
	This function is used to enable or disable the specified Audio port. More...

dsError_t	dsEnableMS12Config (intptr_t handle, dsMS12FEATURE_t feature, const bool enable)
	This function is used to enable or disable MS12 DAPV2 and DE feature. More...

dsError_t	dsEnableLEConfig (intptr_t handle, const bool enable)
	This function is used to enable or disable Loudness Equivalence feature. More...

dsError_t	dsGetLEConfig (intptr_t handle, bool *enable)
	To Get LE configuration. More...

dsError_t	dsSetAudioEncoding (intptr_t handle, dsAudioEncoding_t encoding)
	Set the encoding type of an audio port. More...

dsError_t	dsSetAudioCompression (intptr_t handle, int compression)
	Set the audio compression of an audio port. More...

dsError_t	dsSetDialogEnhancement (intptr_t handle, int level)
	Get the Dialog Enhancement level of an audio port. More...

dsError_t	dsSetDolbyVolumeMode (intptr_t handle, bool mode)
	Get the dolby audio mode status. More...

dsError_t	dsSetIntelligentEqualizerMode (intptr_t handle, int mode)
	Set the Intelligent Equalizer Mode. More...

dsError_t	dsSetVolumeLeveller (intptr_t handle, dsVolumeLeveller_t volLeveller)
	To set the Dolby volume leveller. More...

dsError_t	dsSetBassEnhancer (intptr_t handle, int boost)
	To set the audio Bass. More...

dsError_t	dsEnableSurroundDecoder (intptr_t handle, bool enabled)
	To set the audio Surround Decoder. More...

dsError_t	dsSetDRCMode (intptr_t handle, int mode)
	To set the DRC Mode. More...

dsError_t	dsSetSurroundVirtualizer (intptr_t handle, dsSurroundVirtualizer_t virtualizer)
	To set the audio Surround Virtualizer level. More...

dsError_t	dsSetMISteering (intptr_t handle, bool enabled)
	To set the audio Media intelligent Steering. More...

dsError_t	dsSetGraphicEqualizerMode (intptr_t handle, int mode)
	Get the Graphic Equalizer Mode. More...

dsError_t	dsSetMS12AudioProfile (intptr_t handle, const char *profile)
	To set the ms12 audio profile. More...

dsError_t	dsSetStereoMode (intptr_t handle, dsAudioStereoMode_t mode)
	Set the stereo mode of an audio port. More...

dsError_t	dsSetStereoAuto (intptr_t handle, int autoMode)
	This function sets the auto mode to be used on the specified audio port. More...

dsError_t	dsSetAudioGain (intptr_t handle, float gain)
	Set the audio gain of an audio port. More...

dsError_t	dsSetAudioDB (intptr_t handle, float db)
	This function sets the dB level to be used on the specified audio port. More...

dsError_t	dsSetAudioLevel (intptr_t handle, float level)
	This function sets the audio volume level to be used on the specified audio port. More...

dsError_t	dsSetAudioDucking (intptr_t handle, dsAudioDuckingAction_t action, dsAudioDuckingType_t, const unsigned char level)
	This function sets the audio ducking level to be used on the specified audio port based on the audio output mode. More...

dsError_t	dsEnableLoopThru (intptr_t handle, bool loopThru)
	Set loop-through mode of an audio port. More...

dsError_t	dsSetAudioMute (intptr_t handle, bool mute)
	Mute or un-mute an audio port. More...

dsError_t	dsIsAudioMSDecode (intptr_t handle, bool *HasMS11Decode)
	This function is used to check whether the audio port supports Dolby MS11 Multistream Decode. More...

dsError_t	dsIsAudioMS12Decode (intptr_t handle, bool *HasMS12Decode)
	This function is used to check whether the audio port supports Dolby MS12 Multistream Decode. More...

dsError_t	dsSetAudioDelay (intptr_t handle, const uint32_t audioDelayMs)
	Set the audio delay in milliseconds. More...

dsError_t	dsSetAudioDelayOffset (intptr_t handle, const uint32_t audioDelayOffsetMs)
	Set the audio delay offset in milliseconds. More...

dsError_t	dsAudioPortTerm ()
	Terminate the Audio Port sub-system. More...

dsError_t	dsAudioOutIsConnected (intptr_t handle, bool *pisCon)

dsError_t	dsAudioOutRegisterConnectCB (dsAudioOutPortConnectCB_t CBFunc)

dsError_t	dsAudioFormatUpdateRegisterCB (dsAudioFormatUpdateCB_t cbFun)
	Register for the Audio Format Update Event. More...

dsError_t	dsGetAudioCapabilities (intptr_t handle, int *capabilities)
	To find the HDR capabilities of SoC. More...

dsError_t	dsGetMS12Capabilities (intptr_t handle, int *capabilities)
	To find the HDR capabilities of SoC. More...

dsError_t	dsResetDialogEnhancement (intptr_t handle)
	to reset the Dialog Enhancement More...

dsError_t	dsResetBassEnhancer (intptr_t handle)
	to reset the reset the audio Bass More...

dsError_t	dsResetSurroundVirtualizer (intptr_t handle)
	to reset the audio Surround Virtualizer level More...

dsError_t	dsResetVolumeLeveller (intptr_t handle)
	to reset the Dolby volume leveller More...

dsError_t	dsSetMS12AudioProfileSetttingsOverride (intptr_t handle, const char profileState, const char profileName, const char profileSettingsName, const char profileSettingValue)
	To Set/override a specific audio setting in a specific profile. More...

dsError_t	dsSetAssociatedAudioMixing (intptr_t handle, bool mixing)
	Enable/Disable Associated Audio Mixing. More...

dsError_t	dsGetAssociatedAudioMixing (intptr_t handle, bool *mixing)
	To get the Associated Audio Mixing status - enabled/disabled. More...

dsError_t	dsSetFaderControl (intptr_t handle, int mixerbalance)
	To set the mixerbalance betweeen main and associated audio. More...

dsError_t	dsGetFaderControl (intptr_t handle, int *mixerbalance)
	To get the mixerbalance betweeen main and associated audio. More...

dsError_t	dsSetPrimaryLanguage (intptr_t handle, const char *pLang)
	To set AC4 Primary language. More...

dsError_t	dsGetPrimaryLanguage (intptr_t handle, char *pLang)
	To get AC4 Primary language. More...

dsError_t	dsSetSecondaryLanguage (intptr_t handle, const char *sLang)
	To set AC4 Secondary language. More...

dsError_t	dsGetSecondaryLanguage (intptr_t handle, char *sLang)
	To get AC4 Secondary language. More...

dsError_t	dsGetHDMIARCPortId (int *portId)
	Get the audio HDMI ARC port ID for each platform. More...

Function Documentation

◆ dsAudioPortInit()

dsError_t dsAudioPortInit ( )

Initialize the underlying Audio Port sub-system.

This function must initialize all the audio specific output ports. It must return dsERR_OPERATION_NOT_SUPPORTED when no audio port is present in the device (e.g. a headless gateway device).

Returns: Device Settings error code

Return values

dsERR_NONE	Indicates dsAudioPortInit API was successfully called using iarmbus call.
dsERR_GENERAL	Indicates error due to general failure.

Definition at line 47 of file dsAudio.c.

◆ dsGetAudioPort()

dsError_t dsGetAudioPort	(	dsAudioPortType_t	type,
		int	index,
		intptr_t *	handle
	)

Get the audio port handle.

This function returns the handle for the type of audio port requested. Must return dsERR_OPERATION_NOT_SUPPORTED if an unavailable audio port is requested.

Parameters

[in]	type	Indicates the type of audio port (HDMI, SPDIF and so on).
[in]	index	Index of audio port (0, 1, ...).
[out]	handle	Indicates pointer to hold the handle of the specified audio port.

Returns: Device Settings error code

Return values

dsERR_NONE	Indicates dsGetAudioPort API was successfully called using iarmbus call.
dsERR_GENERAL	Indicates error due to general failure.

Definition at line 66 of file dsAudio.c.

◆ dsGetAudioEncoding()

dsError_t dsGetAudioEncoding	(	intptr_t	handle,
		dsAudioEncoding_t *	encoding
	)

Get the encoding type of an audio port.

This function returns the current audio encoding setting for the specified audio port.

Parameters

[in]	handle	Handle for the audio port.
[out]	encoding	Pointer to hold the encoding setting of the audio port.

Returns: Device Settings error code

Return values

dsERR_OPERATION_NOT_SUPPORTED Indicates this call is not supported.

Definition at line 95 of file dsAudio.c.

◆ dsGetAudioFormat()

dsError_t dsGetAudioFormat	(	intptr_t	handle,
		dsAudioFormat_t *	audioFormat
	)

Get the current audio format.

This function returns the current audio format..

Parameters

[in]	handle	Handle for the audio port
[out]	audioFormat	: Pointer to hold the audio format.

Returns: Device Settings error code

Return values

dsERR_OPERATION_NOT_SUPPORTED Indicates dsGetAudioFormat call is not implemented.

Definition at line 121 of file dsAudio.c.

◆ dsGetAudioCompression()

dsError_t dsGetAudioCompression	(	intptr_t	handle,
		int *	compression
	)

Get the audio compressionof an audio port.

This function returns the audio compression setting used in the specified audio port.

Parameters

[in]	handle	Handle for the audio port.
[out]	compression	Pointer to hold the compression setting of the specified audio port.

Returns: Device Settings error code

Return values

dsERR_OPERATION_NOT_SUPPORTED Indicates this call is not supported.

Definition at line 792 of file dsAudio.c.

◆ dsGetDialogEnhancement()

dsError_t dsGetDialogEnhancement	(	intptr_t	handle,
		int *	level
	)

Get the Dialog Enhancement level of an audio port.

This function returns the audio compression setting used in the specified audio port.

Parameters

[in]	handle	Handle for the audio port.
[out]	Dialog	Enhancement level.

Returns: Device Settings error code

Return values

dsERR_OPERATION_NOT_SUPPORTED Indicates this call is not supported.

Definition at line 815 of file dsAudio.c.

◆ dsGetDolbyVolumeMode()

dsError_t dsGetDolbyVolumeMode	(	intptr_t	handle,
		bool *	mode
	)

Get the dolby audio mode status.

This function returns the dolby audio mode status used in the specified audio port.

Parameters

[in]	handle	Handle for the audio port.
[out]	Dolby	volume mode.

Returns: Device Settings error code

Return values

dsERR_OPERATION_NOT_SUPPORTED Indicates this call is not supported.

Definition at line 838 of file dsAudio.c.

◆ dsGetIntelligentEqualizerMode()

dsError_t dsGetIntelligentEqualizerMode	(	intptr_t	handle,
		int *	mode
	)

Get the Intelligent Equalizer Mode.

This function returns the Intelligent Equalizer Mode setting used in the specified audio port.

Parameters

[in]	handle	Handle for the audio port.
[out]	*mode.	Intelligent Equalizer mode: 0 = Off, 1 = Open, 2 = Rich, 3 = focused, 4 = balanced, 5 = warm, 6 = detailed

Returns: Device Settings error code

Return values

dsERR_OPERATION_NOT_SUPPORTED Indicates this call is not supported.

Definition at line 861 of file dsAudio.c.

◆ dsGetVolumeLeveller()

dsError_t dsGetVolumeLeveller	(	intptr_t	handle,
		dsVolumeLeveller_t *	volLeveller
	)

To get the Dolby volume leveller.

This function will get the Volume leveller value used in a given audio port

Parameters

[in]	handle	Handle for the Output Audio port
[out]	*volLeveller	Volume Leveller setting

Returns: dsError_t Error code.

Definition at line 884 of file dsAudio.c.

◆ dsGetBassEnhancer()

dsError_t dsGetBassEnhancer	(	intptr_t	handle,
		int *	boost
	)

To get the audio Bass.

This function will get the Bass used in a given audio port

Parameters

[in]	handle	Handle for the Output Audio port
[out]	*boost	Bass Enhancer boost value

Returns: dsError_t Error code.

Definition at line 928 of file dsAudio.c.

◆ dsIsSurroundDecoderEnabled()

dsError_t dsIsSurroundDecoderEnabled	(	intptr_t	handle,
		bool *	enabled
	)

To get the audio Surround Decoder.

This function will get enable/disable status of surround decoder

Parameters

[in]	handle	Handle for the Output Audio port
[out]	*enabled	Surround Decoder enable/disable

Returns: dsError_t Error code.

Definition at line 969 of file dsAudio.c.

◆ dsGetDRCMode()

dsError_t dsGetDRCMode	(	intptr_t	handle,
		int *	mode
	)

To get the DRC Mode.

This function will get the Dynamic Range Control used in a given audio port

Parameters

[in]	handle	Handle for the Output Audio port
[out]	*mode	line/RF mode

Returns: dsError_t Error code.

Definition at line 1010 of file dsAudio.c.

◆ dsGetSurroundVirtualizer()

dsError_t dsGetSurroundVirtualizer	(	intptr_t	handle,
		dsSurroundVirtualizer_t *	virtualizer
	)

To get the audio Surround Virtualizer level.

This function will get the Surround Virtualizer level used in a given audio port

Parameters

[in]	handle	Handle for the Output Audio port
[out]	*virtualizer	Surround virtualizer setting

Returns: dsError_t Error code.

Definition at line 1051 of file dsAudio.c.

◆ dsGetMISteering()

dsError_t dsGetMISteering	(	intptr_t	handle,
		bool *	enabled
	)

To get the audio Media intelligent Steering.

This function will get the Media Intelligent Steerinf

Parameters

[in]	handle	Handle for the Output Audio port
[out]	*enabled	enable/disable MI Steering

Returns: dsError_t Error code.

Definition at line 1095 of file dsAudio.c.

◆ dsGetGraphicEqualizerMode()

dsError_t dsGetGraphicEqualizerMode	(	intptr_t	handle,
		int *	mode
	)

Get the Graphic Equalizer Mode.

This function returns the Graphic Equalizer Mode setting used in the specified audio port.

Parameters

[in]	handle	Handle for the audio port.
[out]	.

Returns: Device Settings error code

Return values

dsERR_OPERATION_NOT_SUPPORTED Indicates this call is not supported.

Definition at line 1136 of file dsAudio.c.

◆ dsGetMS12AudioProfileList()

dsError_t dsGetMS12AudioProfileList	(	intptr_t	handle,
		dsMS12AudioProfileList_t *	profiles
	)

To get the supported MS12 audio profiles.

This function will get the list of supported ms12 audio profiles

Parameters

[in]	handle	Handle for the Output Audio port
[out]	*profiles	List of supported audio profiles

Returns: dsError_t Error code.

Definition at line 1178 of file dsAudio.c.

◆ dsGetMS12AudioProfile()

dsError_t dsGetMS12AudioProfile	(	intptr_t	handle,
		char *	profile
	)

To get current audio profile selection.

This function will get the current audio profile configured

Parameters

[in]	handle	Handle for the Output Audio port
[out]	*profile	Audio profile configured currently

Returns: dsError_t Error code.

Definition at line 1201 of file dsAudio.c.

◆ dsGetSupportedARCTypes()

dsError_t dsGetSupportedARCTypes	(	intptr_t	handle,
		int *	types
	)

Get the supported ARC types of the connected ARC/eARC device.

This function gets the supported ARC types of the connected device on ARC/eARC port.

Parameters

[in]	handle	Handle for the HDMI ARC/eARC port.
[out]	*types	OR-ed value of supported ARC types

Returns: Device Settings error code

Return values

dsERR_NONE Indicates dsGetSupportedARCTypes was successfully called using iarmbus.

Definition at line 1504 of file dsAudio.c.

◆ dsAudioSetSAD()

dsError_t dsAudioSetSAD	(	intptr_t	handle,
		dsAudioSADList_t	sad_list
	)

Set Short Audio Descriptor retrieved from CEC for the connected ARC device.

This function sets the Short Audio Descriptor based on best available options of Audio capabilities supported by connected ARC device. Required when ARC output mode is Auto

Parameters

[in]	handle	Handle for the HDMI ARC/eARC port.
[in]	All	SADs retrieved from connected ARC device

Returns: Device Settings error code

Return values

dsERR_NONE Indicates dsGetSupportedARCTypes was successfully called using iarmbus.

Definition at line 1527 of file dsAudio.c.

◆ dsAudioEnableARC()

dsError_t dsAudioEnableARC	(	intptr_t	handle,
		dsAudioARCStatus_t	arcStatus
	)

enable/disable ARC/EARC and route audio to connected device

This function enables/disables ARC/EARC and routes audio to connected device.

Parameters

[in]	handle	Handle for the HDMI ARC/eARC port.
[in]	arcStatus	to enable/disable ARC/eARC feature

Returns: Device Settings error code

Return values

dsERR_NONE Indicates dsAudioEnableARC was successfully called using iarmbus.

Definition at line 1552 of file dsAudio.c.

◆ dsGetStereoMode()

dsError_t dsGetStereoMode	(	intptr_t	handle,
		dsAudioStereoMode_t *	stereoMode
	)

Get the stereo mode of an audio port.

This function gets the stereo mode setting for a specified audio port.

Parameters

[in]	handle	Handle for the audio port.
[out]	stereoMode	Pointer to hold the stereo mode setting of the specified audio port.

Returns: Device Settings error code

Return values

dsERR_NONE Indicates dsGetStereoMode was successfully called using iarmbus.

◆ dsGetStereoAuto()

dsError_t dsGetStereoAuto	(	intptr_t	handle,
		int *	autoMode
	)

This function is used to get the current auto mode setting of the specified audio port.

Parameters

[in]	handle	Handle for the audio port.
[out]	autoMode	Pointer to hold the auto mode setting of the specified audio port.

Returns: Device Settings error code

Return values

dsERR_NONE Indicates dsGetStereoAuto was successfully called using iarmbus.

Definition at line 173 of file dsAudio.c.

◆ dsGetAudioGain()

dsError_t dsGetAudioGain	(	intptr_t	handle,
		float *	gain
	)

Get the audio gain of an audio port.

This function returns the current audio gain for the specified audio port.

Parameters

[in]	handle	Handle for the audio port.
[out]	gain	Pointer to hold the gain value of the specified audio port.

Returns: Device Settings error code

Return values

dsERR_OPERATION_NOT_SUPPORTED Indicates dsGetAudioGain call is not implemented.

Definition at line 197 of file dsAudio.c.

◆ dsGetAudioDB()

dsError_t dsGetAudioDB	(	intptr_t	handle,
		float *	db
	)

Get the current audio dB level of an audio port.

This function returns the current audio dB level for the specified audio port.

Parameters

[in]	handle	Handle for the audio port.
[out]	db	Pointer to hold the dB value of the specified audio port.

Returns: Device Settings error code

Return values

dsERR_OPERATION_NOT_SUPPORTED Indicates dsGetAudioGain call is not implemented.

Definition at line 222 of file dsAudio.c.

◆ dsGetAudioLevel()

dsError_t dsGetAudioLevel	(	intptr_t	handle,
		float *	level
	)

Get the current audio volume level of an audio port.

This function returns the current audio volume level for the specified audio port.

Parameters

[in]	handle	Handle for the audio port.
[out]	level	Pointer to hold the audio level value of the specified audio port.

Returns: Device Settings error code

Return values

dsERR_OPERATION_NOT_SUPPORTED Indicates dsGetAudioLevel call is not implemented.

Definition at line 229 of file dsAudio.c.

◆ dsGetAudioMaxDB()

dsError_t dsGetAudioMaxDB	(	intptr_t	handle,
		float *	maxDb
	)

Get the maximum audio dB level of an audio port.

This function returns the maximum audio dB level supported by the specified audio port.

Parameters

[in]	handle	Handle for the audio port.
[out]	maxDb	Pointer to hold the maximum audio dB value supported by the specified audio port.

Returns: Device Settings error code

Return values

dsERR_NONE Indicates the call was successful.

Definition at line 255 of file dsAudio.c.

◆ dsGetAudioMinDB()

dsError_t dsGetAudioMinDB	(	intptr_t	handle,
		float *	minDb
	)

Get the minimum audio dB level of an audio port.

This function returns the minimum audio dB level supported by the specified audio port.

Parameters

[in]	handle	Handle for the audio port.
[out]	minDb	Pointer to hold the minimum audio dB value supported by the specified audio port.

Returns: Device Settings error code

Return values

dsERR_NONE Indicates the call was successful.

Definition at line 262 of file dsAudio.c.

◆ dsGetAudioOptimalLevel()

dsError_t dsGetAudioOptimalLevel	(	intptr_t	handle,
		float *	optimalLevel
	)

Get the optimal audio level of an audio port.

This function returns the optimal audio level (dB) for the specified audio port.

Parameters

[in]	handle	Handle for the audio port.
[out]	optimalLevel	Pointer to hold the optimal level value of the specified audio port.

Returns: Device Settings error code

Return values

dsERR_OPERATION_NOT_SUPPORTED Indicates dsGetAudioOptimalLevel call is not implemented.

Definition at line 269 of file dsAudio.c.

◆ dsGetAudioDelay()

dsError_t dsGetAudioDelay	(	intptr_t	handle,
		uint32_t *	audioDelayMs
	)

Get the audio delay in milliseconds.

This function will get the audio delay in milliseconds.

Parameters

[in]	handle	Handle for the Output Audio port
[out]	*audioDelayMs	Audio delay in milliseconds

Returns: dsError_t Error code.

Definition at line 1572 of file dsAudio.c.

◆ dsGetAudioDelayOffset()

dsError_t dsGetAudioDelayOffset	(	intptr_t	handle,
		uint32_t *	audioDelayOffsetMs
	)

Get the audio delay offset in milliseconds.

This function will get the audio delay offset in milliseconds.

Parameters

[in]	handle	Handle for the Output Audio port
[out]	*audioDelayOffsetMs	Audio delay offset in milliseconds

Returns: dsError_t Error code.

Definition at line 1595 of file dsAudio.c.

◆ dsSetAudioAtmosOutputMode()

dsError_t dsSetAudioAtmosOutputMode	(	intptr_t	handle,
		bool	enable
	)

Set the audio ATMOS outout mode.

This function will set the Audio Atmos output mode

Parameters

[in]	handle	Handle for the Output Audio port
[in]	enable	set audio ATMOS output mode

Returns: dsError_t Error code.

Definition at line 1619 of file dsAudio.c.

◆ dsGetSinkDeviceAtmosCapability()

dsError_t dsGetSinkDeviceAtmosCapability	(	intptr_t	handle,
		dsATMOSCapability_t *	capability
	)

Get the sink device ATMOS capability.

This function will get the sink device ATMOS capability

Parameters

[in]	handle	Handle for the Output Audio port
[out]	*capability	sink device ATMOS capability

Returns: dsError_t Error code.

Definition at line 1640 of file dsAudio.c.

◆ dsIsAudioLoopThru()

dsError_t dsIsAudioLoopThru	(	intptr_t	handle,
		bool *	loopThru
	)

Get the loop-through mode of an audio port.

This function is used to check if the audio port is configured for loop-through.

Parameters

[in]	handle	Handle for the audio port.
[out]	loopThru	Pointer to hold the loop-through setting of the specified audio.

Returns: Device Settings error code

Return values

dsERR_OPERATION_NOT_SUPPORTED Indicates dsIsAudioLoopThru call is not implemented.

Definition at line 276 of file dsAudio.c.

◆ dsIsAudioMute()

dsError_t dsIsAudioMute	(	intptr_t	handle,
		bool *	muted
	)

Get the audio mute status of an audio port.

This function is used to check whether the audio on a specified port is muted or not.

Parameters

[in]	handle	Handle for the audio port.
[out]	muted	Pointer to hold the mute setting of the specified audio port.

Returns: Device Settings error code

Return values

dsERR_OPERATION_NOT_SUPPORTED Indicates dsIsAudioMute call is not implemented.

Definition at line 284 of file dsAudio.c.

◆ dsIsAudioPortEnabled()

dsError_t dsIsAudioPortEnabled	(	intptr_t	handle,
		bool *	enabled
	)

This function indicates whether the specified Audio port is enabled or not.

Parameters

[in]	handle	Handle of the Audio port.
[out]	enabled	The address of a location to hold the Audio port enable state on return (true when port is enabled, false otherwise).

Returns: Device Settings error code

Return values

dsERR_NONE	If sucessfully dsIsAudioPortEnabled api has been called using IARM support.
dsERR_GENERAL	General failure .

Definition at line 303 of file dsAudio.c.

◆ dsEnableAudioPort()

dsError_t dsEnableAudioPort	(	intptr_t	handle,
		bool	enabled
	)

This function is used to enable or disable the specified Audio port.

Parameters

[in]	handle	Handle of the Audio port.
[in]	enabled	Flag to control the Audio port state (true to enable, false to disable)

Returns: Device Settings error code

Return values

dsERR_NONE	If sucessfully dsEnableAudioPort api has been called using IARM support.
dsERR_GENERAL	General failure.

◆ dsEnableMS12Config()

dsError_t dsEnableMS12Config	(	intptr_t	handle,
		dsMS12FEATURE_t	feature,
		const bool	enable
	)

This function is used to enable or disable MS12 DAPV2 and DE feature.

Parameters

[in]	handle	Handle of the Audio port.
[in]	feature	Enums for MS12 features
[in]	enable	Flag to control the MS12 features (true to enable, false to disable)

Returns: Device Settings error code

Return values

dsERR_NONE	If API executed successfully.
dsERR_GENERAL	General failure.

Definition at line 653 of file dsAudio.c.

◆ dsEnableLEConfig()

dsError_t dsEnableLEConfig	(	intptr_t	handle,
		const bool	enable
	)

This function is used to enable or disable Loudness Equivalence feature.

Parameters

[in]	handle	Handle of the Audio port.
[in]	enable	Flag to control the LE features (true to enable, false to disable)

Returns: Device Settings error code

Return values

dsERR_NONE	If API executed successfully.
dsERR_GENERAL	General failure.

Definition at line 1663 of file dsAudio.c.

◆ dsGetLEConfig()

dsError_t dsGetLEConfig	(	intptr_t	handle,
		bool *	enable
	)

To Get LE configuration.

This function is used to Get LE features

Parameters

[in]	handle	Handle for the Output Audio port
[in]	*enable	true if LE is enabled else False

Returns: dsError_t Error code.

Definition at line 1685 of file dsAudio.c.

◆ dsSetAudioEncoding()

dsError_t dsSetAudioEncoding	(	intptr_t	handle,
		dsAudioEncoding_t	encoding
	)

Set the encoding type of an audio port.

This function sets the audio encoding type to be used on the specified audio port.

Parameters

[in]	handle	Handle for the audio output port.
[in]	encoding	The encoding type to be used on the audio port.

Returns: Device Settings error code

Return values

dsERR_NONE Indicates the call was successful.

Definition at line 413 of file dsAudio.c.

◆ dsSetAudioCompression()

dsError_t dsSetAudioCompression	(	intptr_t	handle,
		int	compression
	)

Set the audio compression of an audio port.

This function sets the audio compression type to be used on the specified audio port.

Parameters

[in]	handle	Handle for the audio port.
[in]	compression	Indicates the compression type to be used on the audio port.

Returns: dsERR_NONE Indicates the call was successful.

Definition at line 737 of file dsAudio.c.

◆ dsSetDialogEnhancement()

dsError_t dsSetDialogEnhancement	(	intptr_t	handle,
		int	level
	)

Get the Dialog Enhancement level of an audio port.

This function returns the audio compression setting used in the specified audio port.

Parameters

[in]	handle	Handle for the audio port.
[out]	Dialog	Enhancement level.

Returns: Device Settings error code

Return values

dsERR_OPERATION_NOT_SUPPORTED Indicates this call is not supported.

Definition at line 719 of file dsAudio.c.

◆ dsSetDolbyVolumeMode()

dsError_t dsSetDolbyVolumeMode	(	intptr_t	handle,
		bool	mode
	)

Get the dolby audio mode status.

This function returns the dolby audio mode status used in the specified audio port.

Parameters

[in]	handle	Handle for the audio port.
[out]	Dolby	volume mode.

Returns: Device Settings error code

Return values

dsERR_OPERATION_NOT_SUPPORTED Indicates this call is not supported.

Definition at line 755 of file dsAudio.c.

◆ dsSetIntelligentEqualizerMode()

dsError_t dsSetIntelligentEqualizerMode	(	intptr_t	handle,
		int	mode
	)

Set the Intelligent Equalizer Mode.

This function returns the Intelligent Equalizer Mode setting used in the specified audio port.

Parameters

[in]	handle	Handle for the audio port.
[in]	mode.	Intelligent Equalizer mode: 0 = Off, 1 = Open, 2 = Rich, 3 = focused, 4 = balanced, 5 = warm, 6 = detailed
[out]	.

Returns: Device Settings error code

Return values

dsERR_OPERATION_NOT_SUPPORTED Indicates this call is not supported.

Definition at line 773 of file dsAudio.c.

◆ dsSetVolumeLeveller()

dsError_t dsSetVolumeLeveller	(	intptr_t	handle,
		dsVolumeLeveller_t	volLeveller
	)

To set the Dolby volume leveller.

This function will set the Volume leveller value used in a given audio port

Parameters

[in]	handle	Handle for the Output Audio port
[in]	volLeveller	Volume Leveller setting

Returns: dsError_t Error code.

Definition at line 909 of file dsAudio.c.

◆ dsSetBassEnhancer()

dsError_t dsSetBassEnhancer	(	intptr_t	handle,
		int	boost
	)

To set the audio Bass.

This function will set the Bass used in a given audio port

Parameters

[in]	handle	Handle for the Output Audio port
[in]	boost	Bass Enhancer boost value

Returns: dsError_t Error code.

Definition at line 951 of file dsAudio.c.

◆ dsEnableSurroundDecoder()

dsError_t dsEnableSurroundDecoder	(	intptr_t	handle,
		bool	enabled
	)

To set the audio Surround Decoder.

This function will enable/disable surround decoder

Parameters

[in]	handle	Handle for the Output Audio port
[in]	enabled	Surround Decoder enable/disable

Returns: dsError_t Error code.

Definition at line 992 of file dsAudio.c.

◆ dsSetDRCMode()

dsError_t dsSetDRCMode	(	intptr_t	handle,
		int	mode
	)

To set the DRC Mode.

This function will set the Dynamic Range Control used in a given audio port

Parameters

[in]	handle	Handle for the Output Audio port
[in]	mode	line/RF mode

Returns: dsError_t Error code.

Definition at line 1033 of file dsAudio.c.

◆ dsSetSurroundVirtualizer()

dsError_t dsSetSurroundVirtualizer	(	intptr_t	handle,
		dsSurroundVirtualizer_t	virtualizer
	)

To set the audio Surround Virtualizer level.

This function will set the Surround Virtualizer level used in a given audio port

Parameters

[in]	handle	Handle for the Output Audio port
[in]	virtualizer	Surround virtualizer setting

Returns: dsError_t Error code.

Definition at line 1076 of file dsAudio.c.

◆ dsSetMISteering()

dsError_t dsSetMISteering	(	intptr_t	handle,
		bool	enabled
	)

To set the audio Media intelligent Steering.

This function will set the Media Intelligent Steerinf

Parameters

[in]	handle	Handle for the Output Audio port
[in]	enabled	enable/disable MI Steering

Returns: dsError_t Error code.

Definition at line 1118 of file dsAudio.c.

◆ dsSetGraphicEqualizerMode()

dsError_t dsSetGraphicEqualizerMode	(	intptr_t	handle,
		int	mode
	)

Get the Graphic Equalizer Mode.

This function returns the Graphic Equalizer Mode setting used in the specified audio port.

Parameters

[in]	handle	Handle for the audio port.
[out]	.

Returns: Device Settings error code

Return values

dsERR_OPERATION_NOT_SUPPORTED Indicates this call is not supported.

Definition at line 1159 of file dsAudio.c.

◆ dsSetMS12AudioProfile()

dsError_t dsSetMS12AudioProfile	(	intptr_t	handle,
		const char *	profile
	)

To set the ms12 audio profile.

This function will configure the user selected ms12 audio profile

Parameters

[in]	handle	Handle for the Output Audio port
[in]	*profile	Audio profile name

Returns: dsError_t Error code.

Definition at line 1224 of file dsAudio.c.

◆ dsSetStereoMode()

dsError_t dsSetStereoMode	(	intptr_t	handle,
		dsAudioStereoMode_t	mode
	)

Set the stereo mode of an audio port.

This function sets the stereo mode to be used on the specified audio port.

Parameters

[in]	handle	Handle for the audio output port.
[in]	mode	Indicates the stereo mode to be used on audio port.

Returns: Device Settings error code

Return values

dsERR_NONE	Indicates the dsSetStereoMode API was successfully called using iarmbus call.
dsERR_GENERAL	Indicates error due to general failure.

◆ dsSetStereoAuto()

dsError_t dsSetStereoAuto	(	intptr_t	handle,
		int	autoMode
	)

This function sets the auto mode to be used on the specified audio port.

Parameters

[in]	handle	Handle for the audio output port.
[in]	autoMode	Indicates the auto mode to be used on audio port.

Returns: Device Settings error code

Return values

dsERR_NONE	Indicates the dsSetStereoAuto API was successfully called using iarmbus call.
dsERR_GENERAL	Indicates error due to general failure.

◆ dsSetAudioGain()

dsError_t dsSetAudioGain	(	intptr_t	handle,
		float	gain
	)

Set the audio gain of an audio port.

This function sets the gain to be used on the specified audio port.

Parameters

[in]	handle	Handle for the audio output port.
[in]	gain	The gain to be used on the audio port.

Returns: Device Settings error code

Return values

dsERR_NONE Indicates the call was successful.

Definition at line 474 of file dsAudio.c.

◆ dsSetAudioDB()

dsError_t dsSetAudioDB	(	intptr_t	handle,
		float	db
	)

This function sets the dB level to be used on the specified audio port.

Parameters

[in]	handle	Handle for the audio output port.
[in]	db	The dB level to be used on the audio port.

Returns: Error Code.

Return values

dsError_t

Definition at line 499 of file dsAudio.c.

◆ dsSetAudioLevel()

dsError_t dsSetAudioLevel	(	intptr_t	handle,
		float	level
	)

This function sets the audio volume level to be used on the specified audio port.

Parameters

[in]	handle	Handle for the audio output port.
[in]	level	The volume level to be used on the audio port.

Returns: Error Code.

Return values

dsError_t

Definition at line 507 of file dsAudio.c.

◆ dsSetAudioDucking()

dsError_t dsSetAudioDucking	(	intptr_t	handle,
		dsAudioDuckingAction_t	action,
		dsAudioDuckingType_t	,
		const unsigned char	level
	)

This function sets the audio ducking level to be used on the specified audio port based on the audio output mode.

Parameters

[in]	handle	Handle for the audio output port.
[in]	action	action type to start or stop ducking.
[in]	type	ducing type is absolute or relative to current volume level.
[in]	level	The volume level to be used on the audio port if output mode is expoert mode this will mute the audio.

Returns: Error Code.

Return values

dsError_t

Definition at line 531 of file dsAudio.c.

◆ dsEnableLoopThru()

dsError_t dsEnableLoopThru	(	intptr_t	handle,
		bool	loopThru
	)

Set loop-through mode of an audio port.

This function enables/disables audio loop-through on the specified audio port.

Parameters

[in]	handle	Handle for the audio output port.
[in]	loopThru	Boolean flag to enable/disable loop-through.

Returns: Device Settings error code

Return values

dsERR_NONE Indicates the call was successful.

Definition at line 558 of file dsAudio.c.

◆ dsSetAudioMute()

dsError_t dsSetAudioMute	(	intptr_t	handle,
		bool	mute
	)

Mute or un-mute an audio port.

This function mutes or unmutes the specified audio output port.

Parameters

[in]	handle	Handle for the audio output port.
[in]	mute	Boolean flag to mute/un-mute the audio port.

Returns: Device Settings error code

Return values

dsERR_NONE	Indicates dsAudioPortInit API was successfully called using iarmbus call.
dsERR_GENERAL	Indicates error due to general failure.

Definition at line 565 of file dsAudio.c.

◆ dsIsAudioMSDecode()

dsError_t dsIsAudioMSDecode	(	intptr_t	handle,
		bool *	HasMS11Decode
	)

This function is used to check whether the audio port supports Dolby MS11 Multistream Decode.

Parameters

[in]	handle	Handle for the audio port.
[out]	Address	to hold the MS11 Multistream Decode setting of the specified audio port.

Returns: Device Settings error code

Return values

dsERR_OPERATION_NOT_SUPPORTED Indicates dsIsAudioMSDecode call is not implemented.

Definition at line 608 of file dsAudio.c.

◆ dsIsAudioMS12Decode()

dsError_t dsIsAudioMS12Decode	(	intptr_t	handle,
		bool *	HasMS12Decode
	)

This function is used to check whether the audio port supports Dolby MS12 Multistream Decode.

Parameters

[out] Address to hold the MS12 Multistream Decode setting of the specified audio port.

Returns: Device Settings error code

Return values

dsERR_OPERATION_NOT_SUPPORTED Indicates dsIsAudioMS12Decode call is not implemented.

Definition at line 630 of file dsAudio.c.

◆ dsSetAudioDelay()

dsError_t dsSetAudioDelay	(	intptr_t	handle,
		const uint32_t	audioDelayMs
	)

Set the audio delay in milliseconds.

This function will set the audio delay in milliseconds

Parameters

[in]	handle	Handle for the Output Audio port
[in]	audioDelayMs	Amount of milliseconds of delay

Returns: dsError_t Error code.

Definition at line 676 of file dsAudio.c.

◆ dsSetAudioDelayOffset()

dsError_t dsSetAudioDelayOffset	(	intptr_t	handle,
		const uint32_t	audioDelayOffsetMs
	)

Set the audio delay offset in milliseconds.

This function will set the audio delay offset in milliseconds

Parameters

[in]	handle	Handle for the Output Audio port
[in]	audioDelayOffsetMs	Amount of milliseconds of delay offset

Returns: dsError_t Error code.

Definition at line 697 of file dsAudio.c.

◆ dsAudioPortTerm()

dsError_t dsAudioPortTerm ( )

Terminate the Audio Port sub-system.

This function will terminate the usage of audio output ports by resetting the data structures used within this module and release the audio port specific handles.

Returns: Device Settings error code

Return values

dsERR_NONE	Indicates dsAudioPortInit API was successfully called using iarmbus call.
dsERR_GENERAL	Indicates error due to general failure.

Definition at line 591 of file dsAudio.c.

◆ dsAudioFormatUpdateRegisterCB()

dsError_t dsAudioFormatUpdateRegisterCB ( dsAudioFormatUpdateCB_t cbFun )

Register for the Audio Format Update Event.

This function is used to register for the the Audio Format Update Event

Parameters

[in] cbFun Audio format update callback function.

Returns: Device Settings error code

Return values

dsError_t

◆ dsGetAudioCapabilities()

dsError_t dsGetAudioCapabilities	(	intptr_t	handle,
		int *	capabilities
	)

To find the HDR capabilities of SoC.

This function is used to check which HDR capabilities the SoC supports

Parameters

[in]	handle	Handle for the audio device (audio decoder)
[out]	*capabilities	OR-ed value of supported HDR standards.

Returns: dsError_t Error code.

Definition at line 1708 of file dsAudio.c.

◆ dsGetMS12Capabilities()

dsError_t dsGetMS12Capabilities	(	intptr_t	handle,
		int *	capabilities
	)

To find the HDR capabilities of SoC.

This function is used to check which HDR capabilities the SoC supports

Parameters

[in]	handle	Handle for the audio device (audio decoder)
[out]	*capabilities	OR-ed value of supported HDR standards.

Returns: dsError_t Error code.

Definition at line 1729 of file dsAudio.c.

◆ dsResetDialogEnhancement()

dsError_t dsResetDialogEnhancement ( intptr_t handle )

to reset the Dialog Enhancement

This function is used to reset the Dialog Enhancement

Parameters

[in] handle Handle for the audio device (audio decoder)

Returns: dsError_t Error code.

Definition at line 1769 of file dsAudio.c.

◆ dsResetBassEnhancer()

dsError_t dsResetBassEnhancer ( intptr_t handle )

to reset the reset the audio Bass

This function is used to reset reset the audio Bass

Parameters

[in] handle Handle for the audio device (audio decoder)

Returns: dsError_t Error code.

Definition at line 1785 of file dsAudio.c.

◆ dsResetSurroundVirtualizer()

dsError_t dsResetSurroundVirtualizer ( intptr_t handle )

to reset the audio Surround Virtualizer level

This function is used to reset the audio Surround Virtualizer level

Parameters

[in] handle Handle for the audio device (audio decoder)

Returns: dsError_t Error code.

Definition at line 1800 of file dsAudio.c.

◆ dsResetVolumeLeveller()

dsError_t dsResetVolumeLeveller ( intptr_t handle )

to reset the Dolby volume leveller

This function is used to reset the Dolby volume leveller

Parameters

[in] handle Handle for the audio device (audio decoder)

Returns: dsError_t Error code.

Definition at line 1815 of file dsAudio.c.

◆ dsSetMS12AudioProfileSetttingsOverride()

dsError_t dsSetMS12AudioProfileSetttingsOverride	(	intptr_t	handle,
		const char *	profileState,
		const char *	profileName,
		const char *	profileSettingsName,
		const char *	profileSettingValue
	)

To Set/override a specific audio setting in a specific profile.

This function will override a specific audio setting in a specific profile

Parameters

[in]	handle	Handle for the Output Audio port
[in]	*profileState	possible values ADD and REMOVE setting from the persistence
[in]	*profileName	ProfileName
[in]	*profileSettingsName	MS12 property name
[in]	*profileSettingValue	MS12 property value

Returns: dsError_t Error code.

Definition at line 1456 of file dsAudio.c.

◆ dsSetAssociatedAudioMixing()

dsError_t dsSetAssociatedAudioMixing	(	intptr_t	handle,
		bool	mixing
	)

Enable/Disable Associated Audio Mixing.

This function will Enable/Disable Associated Audio Mixing

Parameters

[in]	handle	Handle for the Output Audio port (Not Used as setting is not port specific)
[in]	mixing	mixing enable/disable

Returns: dsError_t Error code.

Definition at line 1248 of file dsAudio.c.

◆ dsGetAssociatedAudioMixing()

dsError_t dsGetAssociatedAudioMixing	(	intptr_t	handle,
		bool *	mixing
	)

To get the Associated Audio Mixing status - enabled/disabled.

This function will get the Associated Audio Mixing status

Parameters

[in]	handle	Handle for the Output Audio port (Not Used as setting is not port specific)
[out]	*mixing	Associated Audio Mixing status

Returns: dsError_t Error code.

Definition at line 1267 of file dsAudio.c.

◆ dsSetFaderControl()

dsError_t dsSetFaderControl	(	intptr_t	handle,
		int	mixerbalance
	)

To set the mixerbalance betweeen main and associated audio.

This function will set the mixerbalance betweeen main and associated audio

Parameters

[in]	handle	Handle for the Output Audio port (Not Used as setting is not port specific)
[in]	mixerbalance	int value -32(mute associated) to +32(mute main)

Returns: dsError_t Error code.

Definition at line 1294 of file dsAudio.c.

◆ dsGetFaderControl()

dsError_t dsGetFaderControl	(	intptr_t	handle,
		int *	mixerbalance
	)

To get the mixerbalance betweeen main and associated audio.

This function will get the mixerbalance betweeen main and associated audio

Parameters

[in]	handle	Handle for the Output Audio port (Not Used as setting is not port specific)
[out]	*mixerbalance	int value -32(mute associated) to +32(mute main)

Returns: dsError_t Error code.

Definition at line 1314 of file dsAudio.c.

◆ dsSetPrimaryLanguage()

dsError_t dsSetPrimaryLanguage	(	intptr_t	handle,
		const char *	pLang
	)

To set AC4 Primary language.

This function will set AC4 Primary language

Parameters

[in]	handle	Handle for the Output Audio port (Not Used as setting is not port specific)
[in]	pLang	char* 3 letter lang code should be used as per ISO 639

Returns: dsError_t Error code.

Definition at line 1342 of file dsAudio.c.

◆ dsGetPrimaryLanguage()

dsError_t dsGetPrimaryLanguage	(	intptr_t	handle,
		char *	pLang
	)

To get AC4 Primary language.

This function will get AC4 Primary language

Parameters

[in]	handle	Handle for the Output Audio port (Not Used as setting is not port specific)
[out]	<em>pLang	char 3 letter lang code should be used as per ISO 639

Returns: dsError_t Error code.

Definition at line 1371 of file dsAudio.c.

◆ dsSetSecondaryLanguage()

dsError_t dsSetSecondaryLanguage	(	intptr_t	handle,
		const char *	sLang
	)

To set AC4 Secondary language.

This function will set AC4 Secondary language

Parameters

[in]	handle	Handle for the Output Audio port (Not Used as setting is not port specific)
[in]	pLang	char* 3 letter lang code should be used as per ISO 639

Returns: dsError_t Error code.

Definition at line 1399 of file dsAudio.c.

◆ dsGetSecondaryLanguage()

dsError_t dsGetSecondaryLanguage	(	intptr_t	handle,
		char *	sLang
	)

To get AC4 Secondary language.

This function will get AC4 Secondary language

Parameters

[in]	handle	Handle for the Output Audio port (Not Used as setting is not port specific)
[out]	<em>pLang	char 3 letter lang code should be used as per ISO 639

Returns: dsError_t Error code.

Definition at line 1428 of file dsAudio.c.

◆ dsGetHDMIARCPortId()

dsError_t dsGetHDMIARCPortId ( int * portId )

Get the audio HDMI ARC port ID for each platform.

This function will get audio HDMI ARC port ID

Parameters

[in] portId get audio HDMI ARC port ID

Returns: dsError_t Error code.

Definition at line 1830 of file dsAudio.c.

Description

Functions

Function Documentation

◆ dsAudioPortInit()

◆ dsGetAudioPort()

◆ dsGetAudioEncoding()

◆ dsGetAudioFormat()

◆ dsGetAudioCompression()

◆ dsGetDialogEnhancement()

◆ dsGetDolbyVolumeMode()

◆ dsGetIntelligentEqualizerMode()

◆ dsGetVolumeLeveller()

◆ dsGetBassEnhancer()

◆ dsIsSurroundDecoderEnabled()

◆ dsGetDRCMode()

◆ dsGetSurroundVirtualizer()

◆ dsGetMISteering()

◆ dsGetGraphicEqualizerMode()

◆ dsGetMS12AudioProfileList()

◆ dsGetMS12AudioProfile()

◆ dsGetSupportedARCTypes()

◆ dsAudioSetSAD()

◆ dsAudioEnableARC()

◆ dsGetStereoMode()

◆ dsGetStereoAuto()

◆ dsGetAudioGain()

◆ dsGetAudioDB()

◆ dsGetAudioLevel()

◆ dsGetAudioMaxDB()

◆ dsGetAudioMinDB()

◆ dsGetAudioOptimalLevel()

◆ dsGetAudioDelay()

◆ dsGetAudioDelayOffset()

◆ dsSetAudioAtmosOutputMode()

◆ dsGetSinkDeviceAtmosCapability()

◆ dsIsAudioLoopThru()

◆ dsIsAudioMute()

◆ dsIsAudioPortEnabled()

◆ dsEnableAudioPort()

◆ dsEnableMS12Config()

◆ dsEnableLEConfig()

◆ dsGetLEConfig()

◆ dsSetAudioEncoding()

◆ dsSetAudioCompression()

◆ dsSetDialogEnhancement()

◆ dsSetDolbyVolumeMode()

◆ dsSetIntelligentEqualizerMode()

◆ dsSetVolumeLeveller()

◆ dsSetBassEnhancer()

◆ dsEnableSurroundDecoder()

◆ dsSetDRCMode()

◆ dsSetSurroundVirtualizer()

◆ dsSetMISteering()

◆ dsSetGraphicEqualizerMode()

◆ dsSetMS12AudioProfile()

◆ dsSetStereoMode()

◆ dsSetStereoAuto()

◆ dsSetAudioGain()

◆ dsSetAudioDB()

◆ dsSetAudioLevel()

◆ dsSetAudioDucking()

◆ dsEnableLoopThru()

◆ dsSetAudioMute()

◆ dsIsAudioMSDecode()

◆ dsIsAudioMS12Decode()

◆ dsSetAudioDelay()

◆ dsSetAudioDelayOffset()

◆ dsAudioPortTerm()

◆ dsAudioFormatUpdateRegisterCB()

◆ dsGetAudioCapabilities()

◆ dsGetMS12Capabilities()

◆ dsResetDialogEnhancement()

◆ dsResetBassEnhancer()

◆ dsResetSurroundVirtualizer()

◆ dsResetVolumeLeveller()

◆ dsSetMS12AudioProfileSetttingsOverride()

◆ dsSetAssociatedAudioMixing()

◆ dsGetAssociatedAudioMixing()

◆ dsSetFaderControl()

◆ dsGetFaderControl()