Collapse all Symbian^3 Product Developer Library

MVtEngMedia Class Reference

class MVtEngMedia

Media interface for defining data types for media transport and presentation of it locally as well methods for obtaining current configuration.

videoteleng.lib

Since: Series 60 2.6

Nested Classes and Structures

Public Member Functions
TInt	GetCameraInfo(const TCameraId, TCameraInfo &)
void	GetCameraOrientations(TCameraOrientation &, TCameraOrientation &)
TInt	GetCurrentCameraId(TCameraId &)
TInt	GetCurrentZoomStep(TInt &)
TInt	GetDsaState(const TMediaDirection, TBool &)
TInt	GetFreezeState(TBool &)
TInt	GetFreezeSupported(TBool &)
void	GetMajorZoomStep(TInt, TInt &)
TInt	GetMajorZoomStepCount(TInt &)
TInt	GetMaxZoomStep(TInt &)
TInt	GetMediaState(const TMediaDirection, TInt &)
void	GetObjectSharingState(TShareObjectState &)
TInt	GetSource(TMediaSource &)
TInt	GetSourcesCaps(TInt &)
void	GetVideoQuality(TVideoQuality &)
TBool	RenderingStarted(const TMediaDirection)
TBool	VideoCallConnected()

Public Member Enumerations
enum	TCameraId { EPrimaryCamera, ESecondaryCamera }
enum	TCameraOrientation { EOrientationLandscape, EOrientationPortrait, EOrientationObeyLayoutSwitch }
enum	TMediaDirection { EMediaOutgoing, EMediaIncoming }
enum	TMediaSource { EMediaNone, EMediaCamera, EMediaCameraPri, EMediaCameraSec, EMediaStillImage, EMediaVideoStream, EMediaShare }
enum	TMediaType { EMediaAudio = (1 << 0 ), EMediaVideo = ( 1 << 1 ), EMediaAudioPreparing = ( 1 << 2 ), EMediaVideoPreparing = ( 1 << 3 ), EMediaAudioChannelOpen = ( 1 << 4 ), EMediaVideoChannelOpen = ( 1 << 5 ) }
enum	TShareObjectState { ENotAbleToShare, ENotSharing, EInitializingShareImage, EInitializingShareVideoClip, ESharingImage, ESharingVideoClip }
enum	TSourceCapsFlags { ESourceCapsPrimaryCamera = ( 1 << 0 ), ESourceCapsSecondaryCamera = ( 1 << 1 ), ESourceCapsStillImage = ( 1 << 2 ) }
enum	TVideoQuality { EVideoQualityUndefined, EVideoQualityDetail, EVideoQualityNormal, EVideoQualityMotion }

Public Member Type Definitions
typedef	TFileName TShareObjectImageParameters
typedef	TFileName TShareObjectVideoClipParameters

Member Functions Documentation

GetCameraInfo(const TCameraId, TCameraInfo &)

TInt	GetCameraInfo	(	const TCameraId	aId,
			TCameraInfo &	aInfo
		)	const [pure virtual]

Returns camera information.

Parameters

const TCameraId aId	camera to query information for.
TCameraInfo & aInfo	returns camera information

GetCameraOrientations(TCameraOrientation &, TCameraOrientation &)

void	GetCameraOrientations	(	TCameraOrientation &	aPrimaryCameraOrientation,
			TCameraOrientation &	aSecondaryCameraOrientation
		)	const [pure virtual]

Gets camera orientations for primary and secondary camera. MVtEngMedia::TCameraOrientation

Parameters

TCameraOrientation & aPrimaryCameraOrientation	priamry camera orientation.
TCameraOrientation & aSecondaryCameraOrientation	secondary camera orientation.

GetCurrentCameraId(TCameraId &)

TInt

GetCurrentCameraId

(

TCameraId &

aId

)

const [pure virtual]

Returns currently active camera.

Parameters

TCameraId & aId

GetCurrentZoomStep(TInt &)

TInt

GetCurrentZoomStep

(

TInt &

aCurrentStep

)

[pure virtual]

Gets current zoom step

Parameters

TInt & aCurrentStep

current zoom step

GetDsaState(const TMediaDirection, TBool &)

TInt	GetDsaState	(	const TMediaDirection	aMediaDirection,
			TBool &	aActive
		)	const [pure virtual]

Returns state of DSA drawing, whether is active or not.

Parameters

const TMediaDirection aMediaDirection	in or out direction
TBool & aActive

GetFreezeState(TBool &)

TInt

GetFreezeState

(

TBool &

aFrozen

)

const [pure virtual]

Gets freeze current status.

Since: S60 3.1

Parameters

TBool & aFrozen

GetFreezeSupported(TBool &)

TInt

GetFreezeSupported

(

TBool &

aFreezeSupported

)

const [pure virtual]

Gets freeze support status.

Since: S60 3.1

Parameters

TBool & aFreezeSupported

ETrue if freeze is supported, EFalse otherwise.

GetMajorZoomStep(TInt, TInt &)

void	GetMajorZoomStep	(	TInt	aIndex,
			TInt &	aStep
		)	[pure virtual]

Maps major zoom leap step to corresponding step index.

Parameters

TInt aIndex	major zoom step.
TInt & aStep	zoom step

GetMajorZoomStepCount(TInt &)

TInt

GetMajorZoomStepCount

(

TInt &

aCount

)

[pure virtual]

Gets number of major zoom level leaps. Less than or equal to maximum digital zoom steps.

Parameters

TInt & aCount

number of leaps

GetMaxZoomStep(TInt &)

TInt

GetMaxZoomStep

(

TInt &

aMaxZoomStep

)

[pure virtual]

Gets maximum zoom value that may be passed to camera.

Parameters

TInt & aMaxZoomStep

maximum zoom step.

GetMediaState(const TMediaDirection, TInt &)

TInt	GetMediaState	(	const TMediaDirection	aMediaDirection,
			TInt &	aActiveMedia
		)	const [pure virtual]

Returns state of transmission local video/audio to remote end.

Parameters

const TMediaDirection aMediaDirection
TInt & aActiveMedia	returns active media as bitmap (see TMediaType).

GetObjectSharingState(TShareObjectState &)

void

GetObjectSharingState

(

TShareObjectState &

aObjectSharingState

)

const [pure virtual]

Gets current object sharing state. MVtEngMedia::TShareObjectState.

Since: S60 3.1

Parameters

TShareObjectState & aObjectSharingState

On return contains current object sharing state.

GetSource(TMediaSource &)

TInt

GetSource

(

TMediaSource &

aSource

)

const [pure virtual]

Returns active source for video transmission and local display.

Parameters

TMediaSource & aSource

source in return

GetSourcesCaps(TInt &)

TInt

GetSourcesCaps

(

TInt &

aCaps

)

const [pure virtual]

Returns source capabilities.

Parameters

TInt & aCaps

GetVideoQuality(TVideoQuality &)

void

GetVideoQuality

(

TVideoQuality &

aVideoQuality

)

const [pure virtual]

Gets current local video quality setting.

Since: S60 3.1

Parameters

TVideoQuality & aVideoQuality

Current local video quality settings.

RenderingStarted(const TMediaDirection)

TBool

RenderingStarted

(

const TMediaDirection

aDirection

)

const [pure virtual]

Returns ETrue if rendering has been started.

Parameters

const TMediaDirection aDirection

specifies the rendering direction to check

VideoCallConnected()

TBool

VideoCallConnected

(

)

const [pure virtual]

Returns state of VideoCall, whether is connected or not.

Member Enumerations Documentation

Enum TCameraId

EPrimaryCamera Primary camera is inwards faced. ESecondaryCamera Camera is facing outwards.

Enumerators

EPrimaryCamera
ESecondaryCamera

Enum TCameraOrientation

Defines layout (screen orientation) used by Video Telephone application per active camera. Each camera has one of the following values:

EOrientationLandscape Layout is always landscape. EOrientationPortrait Layout is always portrait. EOrientationObeyLayoutSwitch Obey layout in specific device mode.

Enumerators

EOrientationLandscape
EOrientationPortrait
EOrientationObeyLayoutSwitch

Enum TMediaDirection

EMediaOutgoing outbound media EMediaIncoming inbound media

Enumerators

EMediaOutgoing
EMediaIncoming

Enum TMediaSource

EMediaNone No media source selected. EMediaCamera Camera selected EMediaCameraPri Primary camera selected. Camera is inwards EMediaCameraSec Secondary camera selected. Camera is outwards EMediaStillImage Still image as source. EMediaVideoStream Video stream selected.

Enumerators

EMediaNone
EMediaCamera
EMediaCameraPri
EMediaCameraSec
EMediaStillImage
EMediaVideoStream
EMediaShare

Enum TMediaType

Enumerators

EMediaAudio = (1 << 0 )
EMediaVideo = ( 1 << 1 )
EMediaAudioPreparing = ( 1 << 2 )
EMediaVideoPreparing = ( 1 << 3 )
EMediaAudioChannelOpen = ( 1 << 4 )
EMediaVideoChannelOpen = ( 1 << 5 )

Enum TShareObjectState

Enumerates object sharing state.

ENotAbleToShare Is not able to share any objects (engine in wrong state) ENotSharing Is not sharing anything EInitializingShareImage Initializing still image sharing. ESharingImage Is sharing image ESharingVideoClip Is sharing video clip

Enumerators

ENotAbleToShare
ENotSharing
EInitializingShareImage
EInitializingShareVideoClip
ESharingImage
ESharingVideoClip

Enum TSourceCapsFlags

ESourceCapsPrimaryCamera primary camera can be selected. ESourceCapsSecondaryCamera secondary camera can be selected. ESourceCapsStillImage still image can be selected.

Enumerators

ESourceCapsPrimaryCamera = ( 1 << 0 )
ESourceCapsSecondaryCamera = ( 1 << 1 )
ESourceCapsStillImage = ( 1 << 2 )

Enum TVideoQuality

Video quality enumeration.

EVideoQualityUndefined video quality has not been set yet. EVideoQualityDetail means slow frame rate, good image quality.. EVideoQualityNormal smoother video with somewhat lower image quality than EVideoQualityDetail. EVideoQualityMotion the smoothest video with the worst image quality.

Enumerators

EVideoQualityUndefined
EVideoQualityDetail
EVideoQualityNormal
EVideoQualityMotion

Member Type Definitions Documentation

Typedef TShareObjectImageParameters

typedef TFileName

TShareObjectImageParameters

Command parameters for Image sharing.

Typedef TShareObjectVideoClipParameters

typedef TFileName

TShareObjectVideoClipParameters

Command parameters for Video Clip sharing.