RMMFVideoRecordControllerCustomCommands Class Reference

#include <mmf/common/mmfstandardcustomcommands.h>

Link against: mmfstandardcustomcommands.lib

class RMMFVideoRecordControllerCustomCommands : public RMMFCustomCommandsBase, public RMMFCustomCommandsBase

Inherits from

RMMFVideoRecordControllerCustomCommands
- RMMFCustomCommandsBase
- RMMFCustomCommandsBase

Public Member Functions
	RMMFVideoRecordControllerCustomCommands(RMMFController &)
IMPORT_C void	AddMetaDataEntryL(const CMMFMetaDataEntry &)
IMPORT_C TInt	GetAudioEnabled(TBool &)
IMPORT_C TInt	GetRecordTimeAvailable(TTimeIntervalMicroSeconds &)
IMPORT_C TInt	GetSupportedSinkAudioTypes(RArray< TFourCC > &)
IMPORT_C TInt	GetSupportedSinkVideoTypes(CDesC8Array &)
IMPORT_C TInt	Prepare()
IMPORT_C TInt	RemoveMetaDataEntry(TInt)
IMPORT_C void	ReplaceMetaDataEntryL(TInt, const CMMFMetaDataEntry &)
IMPORT_C TInt	SetAudioBitRate(TInt)
IMPORT_C TInt	SetAudioCodec(TFourCC)
IMPORT_C TInt	SetAudioEnabled(TBool)
IMPORT_C TInt	SetCameraHandle(TInt)
IMPORT_C TInt	SetMaxFileSize(TInt)
IMPORT_C TInt	SetVideoBitRate(TInt)
IMPORT_C TInt	SetVideoCodec(const TDesC8 &)
IMPORT_C TInt	SetVideoFormat(TUid)
IMPORT_C TInt	SetVideoFrameSize(TSize)

Inherited Attributes
	RMMFCustomCommandsBase::iController
	RMMFCustomCommandsBase::iDestinationPckg

Inherited Functions
	RMMFCustomCommandsBase::RMMFCustomCommandsBase(RMMFController &,TUid)

Detailed Description

Client class to access functionality specific to a video recorder controller.

The class uses the custom command function of the controller plugin, and removes the necessity

for the client to formulate the custom commands.

Since: 7.0s

Constructor & Destructor Documentation

RMMFVideoRecordControllerCustomCommands ( RMMFController & )

IMPORT_C

RMMFVideoRecordControllerCustomCommands

(

RMMFController &

aController

)

Constructor.

Since: 7.0s

Parameters
aController	The client side controller object to be used by this custom command interface.

Member Function Documentation

AddMetaDataEntryL ( const CMMFMetaDataEntry & )

IMPORT_C void

AddMetaDataEntryL

(

const CMMFMetaDataEntry &

aNewEntry

)

const

Adds meta data to the clip.

Since: 7.0s

Parameters
aNewEntry	The details of the new entry to be added.

Return Value: One of the system-wide error codes.

GetAudioEnabled ( TBool & )

IMPORT_C TInt

GetAudioEnabled

(

TBool &

aEnabled

)

const

Retrieves whether audio is enabled.

Since: 7.0s

Parameters
aEnabled	A boolean indicating whether audio is enabled.

Return Value: One of the system-wide error codes.

GetRecordTimeAvailable ( TTimeIntervalMicroSeconds & )

IMPORT_C TInt

GetRecordTimeAvailable

(

TTimeIntervalMicroSeconds &

aTime

)

const

Gets the (possibly estimated) record time left in the clip.

Since: 7.0s

Parameters
aTime	The record time available, in microseconds.

Return Value: One of the system-wide error codes.

GetSupportedSinkAudioTypes ( RArray< TFourCC > & )

IMPORT_C TInt

GetSupportedSinkAudioTypes

(

RArray< TFourCC > &

aSupportedDataTypes

)

const

Gets the supported sink audio types.

Since: 7.0s

Parameters
aSupportedDataTypes	The supported data types.

GetSupportedSinkVideoTypes ( CDesC8Array & )

IMPORT_C TInt

GetSupportedSinkVideoTypes

(

CDesC8Array &

aDataTypes

)

const

Gets the supported sink video types.

Since: 7.0s

Parameters
aDataTypes	The supported data types.

Prepare ( )

IMPORT_C TInt

Prepare

(

)

const

Prepares the controller for recording. This should be called before the first attempt to record

with the controller.

Since: 7.0s

Return Value: One of the system-wide error codes.

RemoveMetaDataEntry ( TInt )

IMPORT_C TInt

RemoveMetaDataEntry

(

TInt

aIndex

)

const

Removes a meta data entry from the clip.

Since: 7.0s

Parameters
aIndex	The ID of the meta data entry to delete.

Return Value: One of the system-wide error codes.

ReplaceMetaDataEntryL ( TInt, const CMMFMetaDataEntry & )

IMPORT_C void	ReplaceMetaDataEntryL	(	TInt	aIndex,
			const CMMFMetaDataEntry &	aNewEntry
		)	const

Replaces a meta data in the clip.

Since: 7.0s

Parameters
aIndex	The ID of the meta data entry to replace.
aNewEntry	The details of the new entry to be added.

SetAudioBitRate ( TInt )

IMPORT_C TInt

SetAudioBitRate

(

TInt

aBitRate

)

const

Sets the audio bit rate.

Since: 7.0s

Parameters
aBitRate	The bit rate of the audio stream.

Return Value: One of the system-wide error codes.

SetAudioCodec ( TFourCC )

IMPORT_C TInt

SetAudioCodec

(

TFourCC

aAudioCodec

)

const

Sets the audio codec for recording.

Since: 7.0s

Parameters
aAudioCodec	The FourCC code of the audio codec.

Return Value: One of the system-wide error codes.

SetAudioEnabled ( TBool )

IMPORT_C TInt

SetAudioEnabled

(

TBool

aEnable

)

const

Sets whether audio is enabled.

Since: 7.0s

Parameters
aEnable	A boolean indicating if audio should be enabled.

Return Value: One of the system-wide error codes.

SetCameraHandle ( TInt )

IMPORT_C TInt

SetCameraHandle

(

TInt

aCameraHandle

)

const

Sets the handle of the camera to use.

Since: 7.0s

Parameters
aCameraHandle	The handle of the camera to use.

Return Value: One of the system-wide error codes.

SetMaxFileSize ( TInt )

IMPORT_C TInt

SetMaxFileSize

(

TInt

aMaxSize

)

const

Sets the maximum size of the recorded clip, in bytes.

KMMFNoMaxClipSize which signifies no maximum file size.

Since: 7.0s

Parameters
aMaxSize	The maximum size of the recorded clip, in bytes. This can be called with the parameter

Return Value: One of the system-wide error codes.

SetVideoBitRate ( TInt )

IMPORT_C TInt

SetVideoBitRate

(

TInt

aBitRate

)

const

Sets the video bit rate.

Since: 7.0s

Parameters
aBitRate	The bit rate of the video stream.

Return Value: One of the system-wide error codes.

SetVideoCodec ( const TDesC8 & )

IMPORT_C TInt

SetVideoCodec

(

const TDesC8 &

aVideoCodec

)

const

Sets the video codec for recording.

Since: 7.0s

Parameters
aVideoCodec	The MIME type of the video codec.

Return Value: One of the system-wide error codes.

SetVideoFormat ( TUid )

IMPORT_C TInt

SetVideoFormat

(

TUid

aVideoFormatUid

)

const

Sets the format for the video to record.

Since: 7.0s

Parameters
aVideoFormatUid	The UID of the video format.

Return Value: This method will return with one of the system-wide error codes.

SetVideoFrameSize ( TSize )

IMPORT_C TInt

SetVideoFrameSize

(

TSize

aVideoFrameSize

)

const

Sets the frame size of the clip.

Since: 7.0s

Parameters
aVideoFrameSize	The frame size, in pixels.

Return Value: One of the system-wide error codes.