CRestrictedAudioOutput Class Reference

class CRestrictedAudioOutput : public CBase

CRestrictedAudioOutput class documentation.

Use this class to control audio routing to enforce DRM restrictions.

Instance of this class should be associated with an audio stream. (Currently supported for DevSound API instance). Once associated, it is valid and should be used only until the DevSound instance exist. Instance of this class should be deleted before deleting the DevSound instance.

The output restrictions specified via Commit() will be applied to audio devices when DevSound instance enters playing state.

RestrictedAudioOutput.lib

Since
S60 5.0

Inherits from

  • CRestrictedAudioOutput

Constructor & Destructor Documentation

CRestrictedAudioOutput()

IMPORT_CCRestrictedAudioOutput()[protected]

Constructor

~CRestrictedAudioOutput()

IMPORT_C~CRestrictedAudioOutput()[virtual]

Destructor

Member Functions Documentation

AppendAllowedOutput(TAllowedOutputPreference)

IMPORT_C TIntAppendAllowedOutput(TAllowedOutputPreferenceaOutput)

Appends an allowed output to the existing list.

Parameters

TAllowedOutputPreference aOutputto be appended.

Commit()

TInt Commit()[pure virtual]

Applies settings cached locally and commits.

This function can only be called when the DevSound instance is in Idle OR Stopped state.

Output preference will take into effect when DevSound instance goes to Playing state.

If the client commits an empty list, all other active audio output in the system will be muted.

ConstructL()

IMPORT_C voidConstructL()[protected]

Second phase constructor. The derived class should call this during construction.

GetAllowedOutput(TInt, TAllowedOutputPreference &)

IMPORT_C TIntGetAllowedOutput(TIntaIndex,
TAllowedOutputPreference &aOutput
)

Gets a reference to an allowed output located at a specified position within the list.

Parameters

TInt aIndex
TAllowedOutputPreference & aOutput

GetAllowedOutputCount(TInt &)

IMPORT_C TIntGetAllowedOutputCount(TInt &aSize)

Gets the number of objects in the array.

Parameters

TInt & aSize

RemoveAllowedOutput(TAllowedOutputPreference)

IMPORT_C TIntRemoveAllowedOutput(TAllowedOutputPreferenceaOutput)

Removes an allowed output from the existing list.

Parameters

TAllowedOutputPreference aOutput

Reset()

IMPORT_C TIntReset()

Empties the list, so that it is ready to be reused.

Member Enumerations Documentation

Enum TAllowedOutputPreference

Enumerators

EAllowAllAudio
EAllowAudioAnalog
EAllowAudioFMTransmitter
EAllowAudioBtHFPHSP
EAllowAudioBtA2DP
EAllowAudioUplink
EAllowAudioUsb
EAllowAudioRecording
EAllowVisualization
EAllowAudioHDMI

RIM CR 417-7642: HDMI with HDCP to Resctricted Audio Output API Adding new ENUMs to CRestrictedAudioOutput::TAllowedOutputPreference for HDMI and HDCP EAllowAudioHDMI and EAllowAudioHdmiHdcpRequired

EAllowAudioHdmiHdcpRequired

Member Data Documentation

CRestrictedAudioOutputImpl * iImpl

CRestrictedAudioOutputImpl *iImpl[private]