Symbian^3 Application Developer Library >

RMMFVideoRecordControllerCustomCommands Class Reference

class RMMFVideoRecordControllerCustomCommands : public RMMFCustomCommandsBase

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

Inherits from

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 )
Private Member Functions
void DoGetCDesC8ArrayL ( CDesC8Array &, TMMFVideoRecordControllerMessages )
void DoGetFourCCArrayL ( RArray < TFourCC > &)
Inherited Functions
RMMFCustomCommandsBase::RMMFCustomCommandsBase(RMMFController &,TUid)
Inherited Attributes
RMMFCustomCommandsBase::iController
RMMFCustomCommandsBase::iDestinationPckg

Constructor & Destructor Documentation

RMMFVideoRecordControllerCustomCommands(RMMFController &)

IMPORT_C RMMFVideoRecordControllerCustomCommands ( RMMFController & aController )

Constructor.

Since
7.0s

Parameters

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

Member Functions Documentation

AddMetaDataEntryL(const CMMFMetaDataEntry &)

IMPORT_C void AddMetaDataEntryL ( const CMMFMetaDataEntry & aNewEntry ) const

Adds meta data to the clip.

Since
7.0s

Parameters

const CMMFMetaDataEntry & aNewEntry The details of the new entry to be added.

DoGetCDesC8ArrayL(CDesC8Array &, TMMFVideoRecordControllerMessages)

void DoGetCDesC8ArrayL ( CDesC8Array & aArray,
TMMFVideoRecordControllerMessages aIpc
) const [private]

Parameters

CDesC8Array & aArray
TMMFVideoRecordControllerMessages aIpc

DoGetFourCCArrayL(RArray< TFourCC > &)

void DoGetFourCCArrayL ( RArray < TFourCC > & aArray ) const [private]

Parameters

RArray < TFourCC > & aArray

GetAudioEnabled(TBool &)

IMPORT_C TInt GetAudioEnabled ( TBool & aEnabled ) const

Retrieves whether audio is enabled.

Since
7.0s

Parameters

TBool & aEnabled A boolean indicating whether audio is enabled.

GetRecordTimeAvailable(TTimeIntervalMicroSeconds &)

IMPORT_C TInt GetRecordTimeAvailable ( TTimeIntervalMicroSeconds & aTime ) const

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

Since
7.0s

Parameters

TTimeIntervalMicroSeconds & aTime The record time available, in microseconds.

GetSupportedSinkAudioTypes(RArray< TFourCC > &)

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

Gets the supported sink audio types.

Since
7.0s

Parameters

RArray < TFourCC > & aSupportedDataTypes The supported data types.

GetSupportedSinkVideoTypes(CDesC8Array &)

IMPORT_C TInt GetSupportedSinkVideoTypes ( CDesC8Array & aDataTypes ) const

Gets the supported sink video types.

Since
7.0s

Parameters

CDesC8Array & 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

RemoveMetaDataEntry(TInt)

IMPORT_C TInt RemoveMetaDataEntry ( TInt aIndex ) const

Removes a meta data entry from the clip.

Since
7.0s

Parameters

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

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

TInt aIndex The ID of the meta data entry to replace.
const CMMFMetaDataEntry & 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

TInt aBitRate The bit rate of the audio stream.

SetAudioCodec(TFourCC)

IMPORT_C TInt SetAudioCodec ( TFourCC aAudioCodec ) const

Sets the audio codec for recording.

Since
7.0s

Parameters

TFourCC aAudioCodec The FourCC code of the audio codec.

SetAudioEnabled(TBool)

IMPORT_C TInt SetAudioEnabled ( TBool aEnable ) const

Sets whether audio is enabled.

Since
7.0s

Parameters

TBool aEnable A boolean indicating if audio should be enabled.

SetCameraHandle(TInt)

IMPORT_C TInt SetCameraHandle ( TInt aCameraHandle ) const

Sets the handle of the camera to use.

Since
7.0s

Parameters

TInt aCameraHandle The handle of the camera to use.

SetMaxFileSize(TInt)

IMPORT_C TInt SetMaxFileSize ( TInt aMaxSize ) const

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

Since
7.0s

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.

SetVideoBitRate(TInt)

IMPORT_C TInt SetVideoBitRate ( TInt aBitRate ) const

Sets the video bit rate.

Since
7.0s

Parameters

TInt aBitRate The bit rate of the video stream.

SetVideoCodec(const TDesC8 &)

IMPORT_C TInt SetVideoCodec ( const TDesC8 & aVideoCodec ) const

Sets the video codec for recording.

Since
7.0s

Parameters

const TDesC8 & aVideoCodec The MIME type of the video codec.

SetVideoFormat(TUid)

IMPORT_C TInt SetVideoFormat ( TUid aVideoFormatUid ) const

Sets the format for the video to record.

Since
7.0s

Parameters

TUid aVideoFormatUid The UID of the video format.

SetVideoFrameSize(TSize)

IMPORT_C TInt SetVideoFrameSize ( TSize aVideoFrameSize ) const

Sets the frame size of the clip.

Since
7.0s

Parameters

TSize aVideoFrameSize The frame size, in pixels.

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.