Collapse all Symbian^3 Product Developer Library

RAccessoryAudioControl Class Reference

class RAccessoryAudioControl : public RAccessoryControl

Accessory Audio Control sub-session.

This class is not intended for user derivation.

AccAudioControl.lib

Since: S60 3.1

Inherits from

RAccessoryAudioControl
- RAccessoryControl
  - RAccessoryConnection
    - RAccessoryConnectionBase
      - RAccessorySubsessionBase
        RSubSessionBase

Public Member Functions
	RAccessoryAudioControl()
IMPORT_C void	AccessoryAudioLinkClose(TRequestStatus &, const TAccPolGenericID &, TAccAudioType)
IMPORT_C void	AccessoryAudioLinkOpen(TRequestStatus &, const TAccPolGenericID &, TAccAudioType)
IMPORT_C void	AudioRoutingStatusNotify(TBool, const TAccPolGenericID &)
IMPORT_C void	CancelAccessoryAudioLinkClose()
IMPORT_C void	CancelAccessoryAudioLinkOpen()
IMPORT_C void	CancelNotifyAccessoryAudioLinkClosed()
IMPORT_C void	CancelNotifyAccessoryAudioLinkOpened()
IMPORT_C TInt	CloseSubSession()
IMPORT_C TInt	CreateSubSession(RAccessoryServer &)
IMPORT_C void	NotifyAccessoryAudioLinkClosed(TRequestStatus &, TAccPolGenericID &, TAccAudioType &)
IMPORT_C void	NotifyAccessoryAudioLinkOpened(TRequestStatus &, TAccPolGenericID &, TAccAudioType &)

Inherited Functions
	RAccessoryConnection::CancelGetAccessoryConnectionStatus()const
	RAccessoryConnection::CancelNotifyAccessoryConnectionStatusChanged()const
	RAccessoryConnection::GetAccessoryConnectionStatus(TAccPolGenericIDArray &)const
	RAccessoryConnection::GetAccessoryConnectionStatus(TRequestStatus &,TAccPolGenericIDArray &)
	RAccessoryConnection::NotifyAccessoryConnectionStatusChanged(TRequestStatus &,TAccPolGenericIDArray &)
	RAccessoryConnection::RAccessoryConnection()
	RAccessoryConnectionBase::GetSubblockNameArrayL(const TAccPolGenericID &,CAccPolSubblockNameArray &)const
	RAccessoryConnectionBase::GetValueL(const TAccPolGenericID &,const TAccPolNameRecord &,CAccPolObjectCon &)const
	RAccessoryConnectionBase::GetValueL(const TAccPolGenericID &,const TAccPolNameRecord &,TAccValueTypeTBool &)const
	RAccessoryConnectionBase::GetValueL(const TAccPolGenericID &,const TAccPolNameRecord &,TAccValueTypeTInt &)const
	RAccessoryConnectionBase::GetValueL(const TAccPolGenericID &,const TAccPolNameRecord &,TDes8 &)const
	RAccessoryConnectionBase::RAccessoryConnectionBase()
	RAccessoryControl::AccessoryValueChangedNotifyL(const TAccPolGenericID &,const TAccPolNameRecord &,const CAccPolObjectCon &)const
	RAccessoryControl::AccessoryValueChangedNotifyL(const TAccPolGenericID &,const TAccPolNameRecord &,const TAccValueTypeTBool)const
	RAccessoryControl::AccessoryValueChangedNotifyL(const TAccPolGenericID &,const TAccPolNameRecord &,const TAccValueTypeTInt)const
	RAccessoryControl::CancelConnectAccessory()const
	RAccessoryControl::CancelDisconnectAccessory()const
	RAccessoryControl::ConnectAccessory(TRequestStatus &,CAccConGenericID *const ,TBool)
	RAccessoryControl::ConnectAccessory(TRequestStatus &,TAccPolGenericID &)
	RAccessoryControl::DisconnectAccessory(TRequestStatus &,const TAccPolGenericID &)
	RAccessoryControl::RAccessoryControl()
	RAccessoryControl::SetValueL(const TAccPolGenericID &,const TAccPolNameRecord &,const CAccPolObjectCon &)
	RAccessoryControl::SetValueL(const TAccPolGenericID &,const TAccPolNameRecord &,const TAccValueTypeTBool)
	RAccessoryControl::SetValueL(const TAccPolGenericID &,const TAccPolNameRecord &,const TAccValueTypeTInt)
	RAccessorySubsessionBase::RAccessorySubsessionBase()
	RSubSessionBase::CloseSubSession(TInt)
	RSubSessionBase::CreateAutoCloseSubSession(RSessionBase &,TInt,const TIpcArgs &)
	RSubSessionBase::CreateSubSession(const RSessionBase &,TInt)
	RSubSessionBase::CreateSubSession(const RSessionBase &,TInt,const TIpcArgs &)
	RSubSessionBase::RSubSessionBase()
	RSubSessionBase::Send(TInt)const
	RSubSessionBase::Send(TInt,const TIpcArgs &)const
	RSubSessionBase::SendReceive(TInt)const
	RSubSessionBase::SendReceive(TInt,TRequestStatus &)const
	RSubSessionBase::SendReceive(TInt,const TIpcArgs &)const
	RSubSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
	RSubSessionBase::Session()const
	RSubSessionBase::SubSessionHandle()const

Private Attributes
TAccSrvAudioTypePckgBuf	iAudioLinkCloseAudioTypePckgBuf
TAccSrvGenericIDPckgBuf	iAudioLinkCloseGIDPckgBuf
TAccSrvAudioTypePckgBuf	iAudioLinkOpenAudioTypePckgBuf
TAccSrvGenericIDPckgBuf	iAudioLinkOpenGIDPckgBuf
TInt	iFlags
TPckg< TInt >	iFlagsPckg
TAccSrvAudioTypePckg	iNotifyAudioLinkClosedAudioTypePckg
TAccSrvGenericIDPckg	iNotifyAudioLinkClosedGIDPckg
TAccSrvAudioTypePckg	iNotifyAudioLinkOpenedAudioTypePckg
TAccSrvGenericIDPckg	iNotifyAudioLinkOpenedGIDPckg
TPckg< TInt >	iReserved1
TPckg< TInt >	iReserved2

Constructor & Destructor Documentation

RAccessoryAudioControl()

IMPORT_C

RAccessoryAudioControl

(

)

C++ default constructor.

Member Functions Documentation

AccessoryAudioLinkClose(TRequestStatus &, const TAccPolGenericID &, TAccAudioType)

IMPORT_C void	AccessoryAudioLinkClose	(	TRequestStatus &	aStatus,
			const TAccPolGenericID &	aGenericId,
			TAccAudioType	aAudioType
		)

Request to close accessory audio connection.

Since: S60 3.1

Parameters

TRequestStatus & aStatus	Indicates the completion status of a request. KErrNone if successful, system-wide error code if failed. Specifically: KErrAlreadyExists, if request allready exist KErrCancel, if request is cancelled
const TAccPolGenericID & aGenericId	Generic ID of the accessory
TAccAudioType aAudioType	Type of the audio connection

AccessoryAudioLinkOpen(TRequestStatus &, const TAccPolGenericID &, TAccAudioType)

IMPORT_C void	AccessoryAudioLinkOpen	(	TRequestStatus &	aStatus,
			const TAccPolGenericID &	aGenericId,
			TAccAudioType	aAudioType
		)

Request to open accessory audio connection.

Since: S60 3.1

Parameters

TRequestStatus & aStatus	Indicates the completion status of a request. KErrNone if successful, system-wide error code if failed. Specifically: KErrAlreadyExists, if request allready exist KErrCancel, if request is cancelled
const TAccPolGenericID & aGenericId	Generic ID of the accessory
TAccAudioType aAudioType	Type of the audio connection

AudioRoutingStatusNotify(TBool, const TAccPolGenericID &)

IMPORT_C void	AudioRoutingStatusNotify	(	TBool	aActiveAudio,
			const TAccPolGenericID &	aGenericId
		)

Notifies change of audio routing. Audio subsystem uses this method to notify to which accessory audio is routed or audio routing is stopped.

Since: S60 3.1

Parameters

TBool aActiveAudio	ETrue = Audio is routed according to the aGenericId parameter EFalse = No audio, aGenericId parameter is ignored
const TAccPolGenericID & aGenericId	Generic ID of the accessory. Empty Generic ID means that audio is routed to phone.

CancelAccessoryAudioLinkClose()

IMPORT_C void

CancelAccessoryAudioLinkClose

(

)

const

Cancel AccessoryAudioLinkClose(). This does not leave the accessory audio connection open, it must be opened with AccessoryAudioLinkOpen().

Since: S60 3.1

AccessoryAudioLinkClose

CancelAccessoryAudioLinkOpen()

IMPORT_C void

CancelAccessoryAudioLinkOpen

(

)

const

Cancel AccessoryAudioLinkOpen(). This does not close the accessory audio connection, it must be closed with AccessoryAudioLinkClose().

Since: S60 3.1

AccessoryAudioLinkOpen

CancelNotifyAccessoryAudioLinkClosed()

IMPORT_C void

CancelNotifyAccessoryAudioLinkClosed

(

)

const

Cancel NotifyAccessoryAudioLinkClosed().

Since: S60 3.1

NotifyAccessoryAudioLinkClosed

CancelNotifyAccessoryAudioLinkOpened()

IMPORT_C void

CancelNotifyAccessoryAudioLinkOpened

(

)

const

Cancel NotifyAccessoryAudioLinkOpened().

Since: S60 3.1

NotifyAccessoryAudioLinkOpened

CloseSubSession()

IMPORT_C TInt

CloseSubSession

(

)

[virtual]

Closes the RAccessoryAudioControl sub-session.

Since: S60 3.1

CreateSubSession()

CreateSubSession(RAccessoryServer &)

IMPORT_C TInt

CreateSubSession

(

RAccessoryServer &

aSession

)

[virtual]

Creates a new sub-session within an existing session.

Since: S60 3.1

Parameters

RAccessoryServer & aSession

The session to which this sub-session will belong.

NotifyAccessoryAudioLinkClosed(TRequestStatus &, TAccPolGenericID &, TAccAudioType &)

IMPORT_C void	NotifyAccessoryAudioLinkClosed	(	TRequestStatus &	aStatus,
			TAccPolGenericID &	aGenericId,
			TAccAudioType &	aAudioType
		)

Issues a request for audio link closed notification. Request must be renewed after completion if further notifications are needed.

The notification is not sent to the thread where AccessoryAudioLinkClose() is called. The thread is defined when a sub-session is created.

Since: S60 3.1

Parameters

TRequestStatus & aStatus	Indicates the completion status of a request. KErrNone if successful, system-wide error code if failed. Specifically: KErrAlreadyExists, if request allready exist KErrCancel, if request is cancelled
TAccPolGenericID & aGenericId	On succesfull request completion, contains the updated Generic ID of the accessory
TAccAudioType & aAudioType	On successful request completion, contains the type of audio connection

NotifyAccessoryAudioLinkOpened(TRequestStatus &, TAccPolGenericID &, TAccAudioType &)

IMPORT_C void	NotifyAccessoryAudioLinkOpened	(	TRequestStatus &	aStatus,
			TAccPolGenericID &	aGenericId,
			TAccAudioType &	aAudioType
		)

Issues a request for audio link opened notification. Request must be renewed after completion if further notifications are needed.

The notification is not sent to the thread where AccessoryAudioLinkOpen() is called. The thread is defined when a sub-session is created.

Since: S60 3.1

Parameters

TRequestStatus & aStatus	Indicates the completion status of a request. KErrNone if successful, system-wide error code if failed. Specifically: KErrAlreadyExists, if request allready exist KErrCancel, if request is cancelled
TAccPolGenericID & aGenericId	On succesfull request completion, contains the updated Generic ID of the accessory
TAccAudioType & aAudioType	On successful request completion, contains the type of audio connection