#include <mmfstandardcustomcommands.h>
Link against: mmfstandardcustomcommands.lib

Class `RMMFVideoRecordControllerCustomCommands`

class RMMFVideoRecordControllerCustomCommands : public RMMFCustomCommandsBase;

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.

Derivation

RMMFCustomCommandsBase - Base class for client-side custom command classes.

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

Members

Defined in RMMFVideoRecordControllerCustomCommands:

AddMetaDataEntryL(const CMMFMetaDataEntry &)constAdds meta data to the clip.
GetAudioEnabled(TBool &)constRetrieves whether audio is enabled.
GetRecordTimeAvailable(TTimeIntervalMicroSeconds &)constGets the (possibly estimated) record time left in the clip.
GetSupportedSinkAudioTypes(RArray< TFourCC > &)constGets the supported sink audio types.
GetSupportedSinkVideoTypes(CDesC8Array &)constGets the supported sink video types.
Prepare()constPrepares the controller for recording. This should be called before the first at...
RMMFVideoRecordControllerCustomCommands(RMMFController &)Constructor.
RemoveMetaDataEntry(TInt)constRemoves a meta data entry from the clip.
ReplaceMetaDataEntryL(TInt,const CMMFMetaDataEntry &)constReplaces a meta data in the clip.
SetAudioBitRate(TInt)constSets the audio bit rate.
SetAudioCodec(TFourCC)constSets the audio codec for recording.
SetAudioEnabled(TBool)constSets whether audio is enabled.
SetCameraHandle(TInt)constSets the handle of the camera to use.
SetMaxFileSize(TInt)constSets the maximum size of the recorded clip, in bytes.
SetVideoBitRate(TInt)constSets the video bit rate.
SetVideoCodec(const TDesC8 &)constSets the video codec for recording.
SetVideoFormat(TUid)constSets the format for the video to record.
SetVideoFrameSize(TSize)constSets the frame size of the clip.

Inherited from RMMFCustomCommandsBase:

RMMFCustomCommandsBase(RMMFController &,TUid)Constructor.
iControllerThe controller.
iDestinationPckgThe destination package.

Construction and destruction

`RMMFVideoRecordControllerCustomCommands(RMMFController &)`

IMPORT_C RMMFVideoRecordControllerCustomCommands(RMMFController &aController);

Description

Constructor.

Parameters


                                 						RMMFController &aController

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

Member functions

`SetVideoFormat(TUid)const`

IMPORT_C TInt SetVideoFormat(TUid aVideoFormatUid) const;

Description

Sets the format for the video to record.

Parameters


                                 						TUid aVideoFormatUid

The UID of the video format.

Return value

TInt

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

`SetVideoCodec(const TDesC8 &)const`

IMPORT_C TInt SetVideoCodec(const TDesC8 &aVideoCodec) const;

Description

Sets the video codec for recording.

Parameters

const TDesC8 &aVideoCodec

The MIME type of the video codec.

Return value

TInt

One of the system-wide error codes.

`SetVideoBitRate(TInt)const`

IMPORT_C TInt SetVideoBitRate(TInt aBitRate) const;

Description

Sets the video bit rate.

Parameters


                                 						TInt aBitRate

The bit rate of the video stream.

Return value

TInt

One of the system-wide error codes.

`SetAudioBitRate(TInt)const`

IMPORT_C TInt SetAudioBitRate(TInt aBitRate) const;

Description

Sets the audio bit rate.

Parameters


                                 						TInt aBitRate

The bit rate of the audio stream.

Return value

TInt

One of the system-wide error codes.

`SetAudioCodec(TFourCC)const`

IMPORT_C TInt SetAudioCodec(TFourCC aAudioCodec) const;

Description

Sets the audio codec for recording.

Parameters


                                 						TFourCC aAudioCodec

The FourCC code of the audio codec.

Return value

TInt

One of the system-wide error codes.

`SetVideoFrameSize(TSize)const`

IMPORT_C TInt SetVideoFrameSize(TSize aVideoFrameSize) const;

Description

Sets the frame size of the clip.

Parameters


                                 						TSize aVideoFrameSize

The frame size, in pixels.

Return value

TInt

One of the system-wide error codes.

`SetMaxFileSize(TInt)const`

IMPORT_C TInt SetMaxFileSize(TInt aMaxSize) const;

Description

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

Parameters


                                 						TInt aMaxSize

The maximum size of the recorded clip, in bytes. This can be called with the parameter KMMFNoMaxClipSize which signifies no maximum file size.

Return value

TInt

One of the system-wide error codes.

`AddMetaDataEntryL(const CMMFMetaDataEntry &)const`

IMPORT_C void AddMetaDataEntryL(const CMMFMetaDataEntry &aNewEntry) const;

Description

Adds meta data to the clip.

Parameters

const CMMFMetaDataEntry &aNewEntry

The details of the new entry to be added.

`RemoveMetaDataEntry(TInt)const`

IMPORT_C TInt RemoveMetaDataEntry(TInt aIndex) const;

Description

Removes a meta data entry from the clip.

Parameters


                                 						TInt aIndex

The ID of the meta data entry to delete.

Return value

TInt

One of the system-wide error codes.

`ReplaceMetaDataEntryL(TInt,const CMMFMetaDataEntry &)const`

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

Description

Replaces a meta data in the clip.

Parameters

`TInt aIndex`	The ID of the meta data entry to replace.
`const CMMFMetaDataEntry &aNewEntry`	The details of the new entry to be added.

`SetAudioEnabled(TBool)const`

IMPORT_C TInt SetAudioEnabled(TBool aEnable) const;

Description

Sets whether audio is enabled.

Parameters


                                 						TBool aEnable

A boolean indicating if audio should be enabled.

Return value

TInt

One of the system-wide error codes.

`Prepare()const`

IMPORT_C TInt Prepare() const;

Description

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

Return value

TInt

One of the system-wide error codes.

`SetCameraHandle(TInt)const`

IMPORT_C TInt SetCameraHandle(TInt aCameraHandle) const;

Description

Sets the handle of the camera to use.

Parameters


                                 						TInt aCameraHandle

The handle of the camera to use.

Return value

TInt

One of the system-wide error codes.

`GetRecordTimeAvailable(TTimeIntervalMicroSeconds &)const`

IMPORT_C TInt GetRecordTimeAvailable(TTimeIntervalMicroSeconds &aTime) const;

Description

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

Parameters


                                 						TTimeIntervalMicroSeconds &aTime

The record time available, in microseconds.

Return value

TInt

One of the system-wide error codes.

`GetSupportedSinkAudioTypes(RArray< TFourCC > &)const`

IMPORT_C TInt GetSupportedSinkAudioTypes(RArray< TFourCC > &aSupportedDataTypes) const;

Description

Gets the supported sink audio types.

Parameters


                                 						RArray< TFourCC > &aSupportedDataTypes

The supported data types.

Return value

TInt

`GetSupportedSinkVideoTypes(CDesC8Array &)const`

IMPORT_C TInt GetSupportedSinkVideoTypes(CDesC8Array &aDataTypes) const;

Description

Gets the supported sink video types.

Parameters


                                 						CDesC8Array &aDataTypes

The supported data types.

Return value

TInt

`GetAudioEnabled(TBool &)const`

IMPORT_C TInt GetAudioEnabled(TBool &aEnabled) const;

Description

Retrieves whether audio is enabled.

Parameters


                                 						TBool &aEnabled

A boolean indicating whether audio is enabled.

Return value

TInt

One of the system-wide error codes.

Class RMMFVideoRecordControllerCustomCommands

Description

Derivation

Members

Construction and destruction

RMMFVideoRecordControllerCustomCommands(RMMFController &)

Description

Parameters

Member functions

SetVideoFormat(TUid)const

Description

Parameters

Return value

SetVideoCodec(const TDesC8 &)const

Description

Parameters

Return value

SetVideoBitRate(TInt)const

Description

Parameters

Return value

SetAudioBitRate(TInt)const

Description

Parameters

Return value

SetAudioCodec(TFourCC)const

Description

Parameters

Return value

SetVideoFrameSize(TSize)const

Description

Parameters

Return value

SetMaxFileSize(TInt)const

Description

Parameters

Return value

AddMetaDataEntryL(const CMMFMetaDataEntry &)const

Description

Parameters

RemoveMetaDataEntry(TInt)const

Description

Parameters

Return value

ReplaceMetaDataEntryL(TInt,const CMMFMetaDataEntry &)const

Description

Parameters

SetAudioEnabled(TBool)const

Description

Parameters

Return value

Prepare()const

Description

Return value

SetCameraHandle(TInt)const

Description

Parameters

Return value

GetRecordTimeAvailable(TTimeIntervalMicroSeconds &)const

Description

Parameters

Return value

GetSupportedSinkAudioTypes(RArray< TFourCC > &)const

Description

Parameters

Return value

GetSupportedSinkVideoTypes(CDesC8Array &)const

Description

Parameters

Return value

GetAudioEnabled(TBool &)const

Description

Parameters

Return value

Class `RMMFVideoRecordControllerCustomCommands`

`RMMFVideoRecordControllerCustomCommands(RMMFController &)`

`SetVideoFormat(TUid)const`

`SetVideoCodec(const TDesC8 &)const`

`SetVideoBitRate(TInt)const`

`SetAudioBitRate(TInt)const`

`SetAudioCodec(TFourCC)const`

`SetVideoFrameSize(TSize)const`

`SetMaxFileSize(TInt)const`

`AddMetaDataEntryL(const CMMFMetaDataEntry &)const`

`RemoveMetaDataEntry(TInt)const`

`ReplaceMetaDataEntryL(TInt,const CMMFMetaDataEntry &)const`

`SetAudioEnabled(TBool)const`

`Prepare()const`

`SetCameraHandle(TInt)const`

`GetRecordTimeAvailable(TTimeIntervalMicroSeconds &)const`

`GetSupportedSinkAudioTypes(RArray< TFourCC > &)const`

`GetSupportedSinkVideoTypes(CDesC8Array &)const`

`GetAudioEnabled(TBool &)const`