#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
RMMFVideoRecordControllerCustomCommands
-
Client class to access functionality specific to a video recorder controller.
Members
Defined in RMMFVideoRecordControllerCustomCommands
:
Inherited from RMMFCustomCommandsBase
:
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.
|
|
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
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.
|
|
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
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
Return value
GetSupportedSinkVideoTypes(CDesC8Array &)const
IMPORT_C TInt GetSupportedSinkVideoTypes(CDesC8Array &aDataTypes) const;
Description
Gets the supported sink video types.
Parameters
Return value
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.
|
|