CVideoPlayerUtility Class Reference

class CVideoPlayerUtility : public CBase

Plays sampled video data.

The class offers a simple interface to open, play and obtain information from sampled video data. The video data can be provided using files, descriptors or URLs.

Note: Some video formats also allow the storing of audio data. To accommodate this, this class contains audio functions that can manipulate such data.

While this class is abstract, NewL() constructs, initialises and returns pointers to instances of concrete classes derived from this abstract class. This concrete class is part of the MMF implementation and is private.

7.0s

Inherits from

Public Member Functions
~CVideoPlayerUtility()
IMPORT_C TIntAudioBitRateL()
IMPORT_C TBoolAudioEnabledL()
IMPORT_C TFourCCAudioTypeL()
IMPORT_C TIntBalance()
IMPORT_C TIntCancelRegisterAudioResourceNotification(TUid)
IMPORT_C voidClose()
IMPORT_C const CMMFControllerImplementationInformation &ControllerImplementationInformationL()
IMPORT_C voidCustomCommandAsync(const TMMFMessageDestinationPckg &, TInt, const TDesC8 &, const TDesC8 &, TDes8 &, TRequestStatus &)
IMPORT_C voidCustomCommandAsync(const TMMFMessageDestinationPckg &, TInt, const TDesC8 &, const TDesC8 &, TRequestStatus &)
IMPORT_C TIntCustomCommandSync(const TMMFMessageDestinationPckg &, TInt, const TDesC8 &, const TDesC8 &, TDes8 &)
IMPORT_C TIntCustomCommandSync(const TMMFMessageDestinationPckg &, TInt, const TDesC8 &, const TDesC8 &)
IMPORT_C TTimeIntervalMicroSecondsDurationL()
IMPORT_C voidGetCropRegionL(TRect &)
IMPORT_C MMMFDRMCustomCommand *GetDRMCustomCommand()
IMPORT_C voidGetFrameL(TDisplayMode)
IMPORT_C voidGetFrameL(TDisplayMode, ContentAccess::TIntent)
IMPORT_C voidGetPlayRateCapabilitiesL(TVideoPlayRateCapabilities &)
IMPORT_C voidGetScaleFactorL(TReal32 &, TReal32 &, TBool &)
IMPORT_C voidGetVideoLoadingProgressL(TInt &)
IMPORT_C TIntMaxVolume()
IMPORT_C CMMFMetaDataEntry *MetaDataEntryL(TInt)
IMPORT_C CVideoPlayerUtility *NewL(MVideoPlayerUtilityObserver &, TInt, TInt, RWsSession &, CWsScreenDevice &, RWindowBase &, const TRect &, const TRect &)
IMPORT_C TIntNumberOfMetaDataEntriesL()
IMPORT_C voidOpenDesL(const TDesC8 &, TUid)
IMPORT_C voidOpenFileL(const TDesC &, TUid)
IMPORT_C voidOpenFileL(const RFile &, TUid)
IMPORT_C voidOpenFileL(const TMMSource &, TUid)
IMPORT_C voidOpenUrlL(const TDesC &, TInt, const TDesC8 &, TUid)
IMPORT_C voidPauseL()
IMPORT_C voidPlay()
IMPORT_C voidPlay(const TTimeIntervalMicroSeconds &, const TTimeIntervalMicroSeconds &)
IMPORT_C TIntPlayVelocityL()
IMPORT_C TTimeIntervalMicroSecondsPositionL()
IMPORT_C voidPrepare()
IMPORT_C voidPriorityL(TInt &, TMdaPriorityPreference &)
IMPORT_C voidRefreshFrameL()
IMPORT_C TIntRegisterAudioResourceNotification(MMMFAudioResourceNotificationCallback &, TUid, const TDesC8 &)
IMPORT_C voidRegisterForVideoLoadingNotification(MVideoLoadingObserver &)
IMPORT_C TVideoRotationRotationL()
IMPORT_C voidSetAudioEnabledL(TBool)
IMPORT_C voidSetAutoScaleL(TAutoScaleType)
IMPORT_C voidSetAutoScaleL(TAutoScaleType, TInt, TInt)
IMPORT_C voidSetBalanceL(TInt)
IMPORT_C voidSetCropRegionL(const TRect &)
IMPORT_C voidSetDisplayWindowL(RWsSession &, CWsScreenDevice &, RWindowBase &, const TRect &, const TRect &)
IMPORT_C voidSetExternalDisplaySwitchingL(TInt, TBool)
IMPORT_C TIntSetInitScreenNumber(TInt)
IMPORT_C voidSetPlayVelocityL(TInt)
IMPORT_C voidSetPositionL(const TTimeIntervalMicroSeconds &)
IMPORT_C voidSetPriorityL(TInt, TInt)
IMPORT_C voidSetRotationL(TVideoRotation)
IMPORT_C voidSetScaleFactorL(TReal32, TReal32, TBool)
IMPORT_C voidSetVideoEnabledL(TBool)
IMPORT_C voidSetVideoFrameRateL(TReal32)
IMPORT_C voidSetVolumeL(TInt)
IMPORT_C voidStartDirectScreenAccessL()
IMPORT_C voidStepFrameL(TInt)
IMPORT_C TIntStop()
IMPORT_C voidStopDirectScreenAccessL()
IMPORT_C TIntVideoBitRateL()
IMPORT_C TBoolVideoEnabledL()
IMPORT_C const TDesC8 &VideoFormatMimeType()
IMPORT_C TReal32VideoFrameRateL()
IMPORT_C voidVideoFrameSizeL(TSize &)
IMPORT_C TIntVolume()
IMPORT_C TIntWillResumePlay()
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Private Member Enumerations
enumTMMFVideoPlayerState { EStopped, EOpening, EPaused, EPlaying }
Private Attributes
CBody *iBody

Constructor & Destructor Documentation

~CVideoPlayerUtility()

~CVideoPlayerUtility()

Member Functions Documentation

AudioBitRateL()

IMPORT_C TIntAudioBitRateL()const

AudioEnabledL()

IMPORT_C TBoolAudioEnabledL()const

AudioTypeL()

IMPORT_C TFourCCAudioTypeL()const

Balance()

IMPORT_C TIntBalance()const

CancelRegisterAudioResourceNotification(TUid)

IMPORT_C TIntCancelRegisterAudioResourceNotification(TUidaNotificationEventId)

Parameters

TUid aNotificationEventId

Close()

IMPORT_C voidClose()

ControllerImplementationInformationL()

IMPORT_C const CMMFControllerImplementationInformation &ControllerImplementationInformationL()

CustomCommandAsync(const TMMFMessageDestinationPckg &, TInt, const TDesC8 &, const TDesC8 &, TDes8 &, TRequestStatus &)

IMPORT_C voidCustomCommandAsync(const TMMFMessageDestinationPckg &aDestination,
TIntaFunction,
const TDesC8 &aDataTo1,
const TDesC8 &aDataTo2,
TDes8 &aDataFrom,
TRequestStatus &aStatus
)

Parameters

const TMMFMessageDestinationPckg & aDestination
TInt aFunction
const TDesC8 & aDataTo1
const TDesC8 & aDataTo2
TDes8 & aDataFrom
TRequestStatus & aStatus

CustomCommandAsync(const TMMFMessageDestinationPckg &, TInt, const TDesC8 &, const TDesC8 &, TRequestStatus &)

IMPORT_C voidCustomCommandAsync(const TMMFMessageDestinationPckg &aDestination,
TIntaFunction,
const TDesC8 &aDataTo1,
const TDesC8 &aDataTo2,
TRequestStatus &aStatus
)

Parameters

const TMMFMessageDestinationPckg & aDestination
TInt aFunction
const TDesC8 & aDataTo1
const TDesC8 & aDataTo2
TRequestStatus & aStatus

CustomCommandSync(const TMMFMessageDestinationPckg &, TInt, const TDesC8 &, const TDesC8 &, TDes8 &)

IMPORT_C TIntCustomCommandSync(const TMMFMessageDestinationPckg &aDestination,
TIntaFunction,
const TDesC8 &aDataTo1,
const TDesC8 &aDataTo2,
TDes8 &aDataFrom
)

Parameters

const TMMFMessageDestinationPckg & aDestination
TInt aFunction
const TDesC8 & aDataTo1
const TDesC8 & aDataTo2
TDes8 & aDataFrom

CustomCommandSync(const TMMFMessageDestinationPckg &, TInt, const TDesC8 &, const TDesC8 &)

IMPORT_C TIntCustomCommandSync(const TMMFMessageDestinationPckg &aDestination,
TIntaFunction,
const TDesC8 &aDataTo1,
const TDesC8 &aDataTo2
)

Parameters

const TMMFMessageDestinationPckg & aDestination
TInt aFunction
const TDesC8 & aDataTo1
const TDesC8 & aDataTo2

DurationL()

IMPORT_C TTimeIntervalMicroSecondsDurationL()const

GetCropRegionL(TRect &)

IMPORT_C voidGetCropRegionL(TRect &aCropRegion)const

Parameters

TRect & aCropRegion

GetDRMCustomCommand()

IMPORT_C MMMFDRMCustomCommand *GetDRMCustomCommand()

GetFrameL(TDisplayMode)

IMPORT_C voidGetFrameL(TDisplayModeaDisplayMode)

Parameters

TDisplayMode aDisplayMode

GetFrameL(TDisplayMode, ContentAccess::TIntent)

IMPORT_C voidGetFrameL(TDisplayModeaDisplayMode,
ContentAccess::TIntentaIntent
)

Parameters

TDisplayMode aDisplayMode
ContentAccess::TIntent aIntent

GetPlayRateCapabilitiesL(TVideoPlayRateCapabilities &)

IMPORT_C voidGetPlayRateCapabilitiesL(TVideoPlayRateCapabilities &aCapabilities)const

Parameters

TVideoPlayRateCapabilities & aCapabilities

GetScaleFactorL(TReal32 &, TReal32 &, TBool &)

IMPORT_C voidGetScaleFactorL(TReal32 &aWidthPercentage,
TReal32 &aHeightPercentage,
TBool &aAntiAliasFiltering
)const

Parameters

TReal32 & aWidthPercentage
TReal32 & aHeightPercentage
TBool & aAntiAliasFiltering

GetVideoLoadingProgressL(TInt &)

IMPORT_C voidGetVideoLoadingProgressL(TInt &aPercentageComplete)

Parameters

TInt & aPercentageComplete

MaxVolume()

IMPORT_C TIntMaxVolume()const

MetaDataEntryL(TInt)

IMPORT_C CMMFMetaDataEntry *MetaDataEntryL(TIntaIndex)const

Parameters

TInt aIndex

NewL(MVideoPlayerUtilityObserver &, TInt, TInt, RWsSession &, CWsScreenDevice &, RWindowBase &, const TRect &, const TRect &)

IMPORT_C CVideoPlayerUtility *NewL(MVideoPlayerUtilityObserver &aObserver,
TIntaPriority,
TIntaPref,
RWsSession &aWs,
CWsScreenDevice &aScreenDevice,
RWindowBase &aWindow,
const TRect &aScreenRect,
const TRect &aClipRect
)[static]

Parameters

MVideoPlayerUtilityObserver & aObserver
TInt aPriority
TInt aPref
RWsSession & aWs
CWsScreenDevice & aScreenDevice
RWindowBase & aWindow
const TRect & aScreenRect
const TRect & aClipRect

NumberOfMetaDataEntriesL()

IMPORT_C TIntNumberOfMetaDataEntriesL()const

OpenDesL(const TDesC8 &, TUid)

IMPORT_C voidOpenDesL(const TDesC8 &aDescriptor,
TUidaControllerUid = KNullUid
)

Parameters

const TDesC8 & aDescriptor
TUid aControllerUid = KNullUid

OpenFileL(const TDesC &, TUid)

IMPORT_C voidOpenFileL(const TDesC &aFileName,
TUidaControllerUid = KNullUid
)

Parameters

const TDesC & aFileName
TUid aControllerUid = KNullUid

OpenFileL(const RFile &, TUid)

IMPORT_C voidOpenFileL(const RFile &aFileName,
TUidaControllerUid = KNullUid
)

Parameters

const RFile & aFileName
TUid aControllerUid = KNullUid

OpenFileL(const TMMSource &, TUid)

IMPORT_C voidOpenFileL(const TMMSource &aSource,
TUidaControllerUid = KNullUid
)

Parameters

const TMMSource & aSource
TUid aControllerUid = KNullUid

OpenUrlL(const TDesC &, TInt, const TDesC8 &, TUid)

IMPORT_C voidOpenUrlL(const TDesC &aUrl,
TIntaIapId =  KUseDefaultIap ,
const TDesC8 &aMimeType =  KNullDesC8 ,
TUidaControllerUid = KNullUid
)

Parameters

const TDesC & aUrl
TInt aIapId =  KUseDefaultIap
const TDesC8 & aMimeType =  KNullDesC8
TUid aControllerUid = KNullUid

PauseL()

IMPORT_C voidPauseL()

Play()

IMPORT_C voidPlay()

Play(const TTimeIntervalMicroSeconds &, const TTimeIntervalMicroSeconds &)

IMPORT_C voidPlay(const TTimeIntervalMicroSeconds &aStartPoint,
const TTimeIntervalMicroSeconds &aEndPoint
)

Parameters

const TTimeIntervalMicroSeconds & aStartPoint
const TTimeIntervalMicroSeconds & aEndPoint

PlayVelocityL()

IMPORT_C TIntPlayVelocityL()const

PositionL()

IMPORT_C TTimeIntervalMicroSecondsPositionL()const

Prepare()

IMPORT_C voidPrepare()

PriorityL(TInt &, TMdaPriorityPreference &)

IMPORT_C voidPriorityL(TInt &aPriority,
TMdaPriorityPreference &aPref
)const

Parameters

TInt & aPriority
TMdaPriorityPreference & aPref

RefreshFrameL()

IMPORT_C voidRefreshFrameL()

RegisterAudioResourceNotification(MMMFAudioResourceNotificationCallback &, TUid, const TDesC8 &)

IMPORT_C TIntRegisterAudioResourceNotification(MMMFAudioResourceNotificationCallback &aCallback,
TUidaNotificationEventUid,
const TDesC8 &aNotificationRegistrationData =  KNullDesC8
)

Parameters

MMMFAudioResourceNotificationCallback & aCallback
TUid aNotificationEventUid
const TDesC8 & aNotificationRegistrationData =  KNullDesC8

RegisterForVideoLoadingNotification(MVideoLoadingObserver &)

IMPORT_C voidRegisterForVideoLoadingNotification(MVideoLoadingObserver &aCallback)

Parameters

MVideoLoadingObserver & aCallback

RotationL()

IMPORT_C TVideoRotationRotationL()const

SetAudioEnabledL(TBool)

IMPORT_C voidSetAudioEnabledL(TBoolaAudioEnabled)

Parameters

TBool aAudioEnabled

SetAutoScaleL(TAutoScaleType)

IMPORT_C voidSetAutoScaleL(TAutoScaleTypeaScaleType)

Parameters

TAutoScaleType aScaleType

SetAutoScaleL(TAutoScaleType, TInt, TInt)

IMPORT_C voidSetAutoScaleL(TAutoScaleTypeaScaleType,
TIntaHorizPos,
TIntaVertPos
)

Parameters

TAutoScaleType aScaleType
TInt aHorizPos
TInt aVertPos

SetBalanceL(TInt)

IMPORT_C voidSetBalanceL(TIntaBalance)

Parameters

TInt aBalance

SetCropRegionL(const TRect &)

IMPORT_C voidSetCropRegionL(const TRect &aCropRegion)

Parameters

const TRect & aCropRegion

SetDisplayWindowL(RWsSession &, CWsScreenDevice &, RWindowBase &, const TRect &, const TRect &)

IMPORT_C voidSetDisplayWindowL(RWsSession &aWs,
CWsScreenDevice &aScreenDevice,
RWindowBase &aWindow,
const TRect &aWindowRect,
const TRect &aClipRect
)

Parameters

RWsSession & aWs
CWsScreenDevice & aScreenDevice
RWindowBase & aWindow
const TRect & aWindowRect
const TRect & aClipRect

SetExternalDisplaySwitchingL(TInt, TBool)

IMPORT_C voidSetExternalDisplaySwitchingL(TIntaDisplay,
TBoolaControl
)

Parameters

TInt aDisplay
TBool aControl

SetInitScreenNumber(TInt)

IMPORT_C TIntSetInitScreenNumber(TIntaScreenNumber)

Parameters

TInt aScreenNumber

SetPlayVelocityL(TInt)

IMPORT_C voidSetPlayVelocityL(TIntaVelocity)

Parameters

TInt aVelocity

SetPositionL(const TTimeIntervalMicroSeconds &)

IMPORT_C voidSetPositionL(const TTimeIntervalMicroSeconds &aPosition)

Parameters

const TTimeIntervalMicroSeconds & aPosition

SetPriorityL(TInt, TInt)

IMPORT_C voidSetPriorityL(TIntaPriority,
TIntaPref
)

Parameters

TInt aPriority
TInt aPref

SetRotationL(TVideoRotation)

IMPORT_C voidSetRotationL(TVideoRotationaRotation)

Parameters

TVideoRotation aRotation

SetScaleFactorL(TReal32, TReal32, TBool)

IMPORT_C voidSetScaleFactorL(TReal32aWidthPercentage,
TReal32aHeightPercentage,
TBoolaAntiAliasFiltering
)

Parameters

TReal32 aWidthPercentage
TReal32 aHeightPercentage
TBool aAntiAliasFiltering

SetVideoEnabledL(TBool)

IMPORT_C voidSetVideoEnabledL(TBoolaVideoEnabled)

Parameters

TBool aVideoEnabled

SetVideoFrameRateL(TReal32)

IMPORT_C voidSetVideoFrameRateL(TReal32aFramesPerSecond)

Parameters

TReal32 aFramesPerSecond

SetVolumeL(TInt)

IMPORT_C voidSetVolumeL(TIntaVolume)

Parameters

TInt aVolume

StartDirectScreenAccessL()

IMPORT_C voidStartDirectScreenAccessL()

StepFrameL(TInt)

IMPORT_C voidStepFrameL(TIntaStep)

Parameters

TInt aStep

Stop()

IMPORT_C TIntStop()

StopDirectScreenAccessL()

IMPORT_C voidStopDirectScreenAccessL()

VideoBitRateL()

IMPORT_C TIntVideoBitRateL()const

VideoEnabledL()

IMPORT_C TBoolVideoEnabledL()const

VideoFormatMimeType()

IMPORT_C const TDesC8 &VideoFormatMimeType()const

VideoFrameRateL()

IMPORT_C TReal32VideoFrameRateL()const

VideoFrameSizeL(TSize &)

IMPORT_C voidVideoFrameSizeL(TSize &aSize)const

Parameters

TSize & aSize

Volume()

IMPORT_C TIntVolume()const

WillResumePlay()

IMPORT_C TIntWillResumePlay()

Member Enumerations Documentation

Enum TMMFVideoPlayerState

Enumerators

EStopped
EOpening
EPaused
EPlaying

Member Data Documentation

CBody * iBody

CBody *iBody[private]
© Nokia 2010.