Destructor. Closes any open video clips and frees any resources held by the Video Player.

Returns the audio bit rate in bits/second.

Returns whether the current clip has an audio stream and audio playback is enabled. This method will return EFalse if the clip does no have an audio track or if audio playback has been disabled with SetAudioEnabledL().

Returns the codec used for the audio component of the video clip.

Returns the current balance setting for the audio track of the video clip.

Cancels the registration for audio resource notification.

Closes the video clip.

Returns the controller implementation information associated with the current controller.

Sends an asynchronous custom command to the controller.

Note: This method will return immediately. The RunL of the active object owning the aStatus parameter will be called when the command is completed by the controller framework.

Send a asynchronous custom command to the controller.

Note: This method will return immediately. The RunL of the active object owning the aStatus parameter will be called when the command is completed by the controller framework.

Sends a synchronous custom command to the controller.

Sends a synchronous custom command to the controller.

Returns the duration of video clip in mircoseconds.

Gets the crop region currently applied to the image.

Gets a controller's DRM custom command implementation.

Gets the current frame. The current frame is requested, and will be sent to the client asynchrynously via the MvpuoFrameReady callback.

Gets the current frame. The current frame is requested, and will be sent to the client asynchrynously via the MvpuoFrameReady callback.

Queries the current playback rate capabilities. The capabilities describe whether fast forward, reverse playback, slow motion, or step backward or forward is possible. The capabilities may depend on the controller implementation and the video clip. Additionally, only normal-speed forward playback is typically possible in streamed playback.

This function quits or exits leaving any of the system wide error codes. Common error codes are listed below.

Gets the scale factor currently applied to the video image.

Gets the progress of video clip loading/rebuffering.

Returns an integer representing the maximum volume that the audio track can support.

This is the maximum value that can be passed to SetVolumeL(). This value is platform independent, but is always greater than or equal to one.

Returns a meta data entry from the clip.

Constructs and initialises a new instance of the video player utility.

This function leaves if the video player utility object cannot be created.

Returns the number of meta data entries associated with this clip.

Opens a video clip contained in a descriptor.

This function opens a video clip contained as binary data in a descriptor using an optionally specified plugin. If no controller plugin is specified, this function searches through a list of all available plugins and attempts to use each one until successful or the end of the list is reached.

Once the opening of the video clip is complete, successfully or otherwise, the callback function MVideoPlayerUtilityObserver::MvpuoOpenComplete() is called.

This function can leave with one of the specified error codes. Most open failures will however be reported through the interface.

From Symbian release v9.5 onwards, this function will enable graphics surface use if the controller supports it. If this function is called through an instance of the derived class CVideoPlayerUtility2 and the controller doesn't support graphics surfaces, it fails with KErrNotSupported.

Opens a video clip from a file.

This function opens a video clip from a file using an optionally specified plugin. If no controller plugin is specified, this function searches through a list of all available plugins and attempts to use each one until successful or the end of the list is reached.

Once the opening of the video clip is complete, successfully or otherwise, the callback function MVideoPlayerUtilityObserver::MvpuoOpenComplete() is called.

This function leaves if errors are encountered opening the specified video clip file, or in initialising a specified/unspecified controller plugin.

This function can leave with one of the specified error codes. Most open failures will however be reported through the MVideoPlayerUtilityObserver interface.

From Symbian release v9.5 onwards, this function will enable graphics surface use if the controller supports it. If this function is called through an instance of the derived class CVideoPlayerUtility2 and the controller doesn't support graphics surfaces, it fails with KErrNotSupported.

Opens a video clip from a file.

This function opens a video clip from a file using an optionally specified plugin. If no controller plugin is specified, this function searches through a list of all available plugins and attempts to use each one until successful or the end of the list is reached.

Once the opening of the video clip is complete, successfully or otherwise, the callback function MVideoPlayerUtilityObserver::MvpuoOpenComplete() is called.

This function leaves if errors are encountered opening the specified video clip file, or in initialising a specified/unspecified controller plugin.

This function can leave with one of the specified error codes. Most open failures will however be reported through the MVideoPlayerUtilityObserver interface.

From Symbian release v9.5 onwards, this function will enable graphics surface use if the controller supports it. If this function is called through an instance of the derived class CVideoPlayerUtility2 and the controller doesn't support graphics surfaces, it fails with KErrNotSupported.

Opens a video clip from a file.

This function opens a video clip from a file using an optionally specified plugin. If no controller plugin is specified, this function searches through a list of all available plugins and attempts to use each one until successful or the end of the list is reached.

Once the opening of the video clip is complete, successfully or otherwise, the callback function MVideoPlayerUtilityObserver::MvpuoOpenComplete() is called.

This function leaves if errors are encountered opening the specified video clip file, or in initialising a specified/unspecified controller plugin.

This function can leave with one of the specified error codes. Most open failures will however be reported through the MVideoPlayerUtilityObserver interface.

From Symbian release v9.5 onwards, this function will enable graphics surface use if the controller supports it. If this function is called through an instance of the derived class CVideoPlayerUtility2 and the controller doesn't support graphics surfaces, it fails with KErrNotSupported.

Opens a video clip from a URL.

This function opens a video clip stored at a specified URL and identified by a MIME type. In addition a plugin can be specified if necessary. If no controller plugin is specified, this function searches through a list of all available plugins and attempts to use each one until successful or the end of the list is reached.

Once the opening of the video clip is complete, successfully or otherwise, the callback function MVideoPlayerUtilityObserver::MvpuoOpenComplete() is called.

This function can leave with one of the specified error codes. Most open failures will however be reported through the MVideoPlayerUtilityObserver interface.

From Symbian release v9.5 onwards, this function will enable graphics surface use if the controller supports it. If this function is called through an instance of the derived class CVideoPlayerUtility2 and the controller doesn't support graphics surfaces, it fails with KErrNotSupported.

Video playback is paused. The current position is maintained and playback can be resumed by calling Play.

Begins playback of the initialised video sample at the current volume and priority levels.

When playing of the video sample is complete, successfully or otherwise, the callback function MVideoPlayerUtilityObserver::MvpuoPlayComplete() is called.

Begins playback of the initialised video sample at the specified start and end points.

When playing of the video sample is complete, successfully or otherwise, the callback function MVideoPlayerUtilityObserver::MvpuoPlayComplete() is called.

Returns the current playback velocity. If setting play velocity is not supported or velocity is not set this will return default play velocity 100 corresponding to normal playback.

If implementation is not supporting the velocity set with SetPlayVelocityL it will default to the nearest velocity. In this case this API will return the value it has defaulted to.

If an error occurs, this function leaves with any of the system wide error codes. Common error codes are listed below.

Returns the current playback position.

Prepares the video clip to be accessed.

A call to this method tells the loaded controller plugin to finalise its configuration and to prepare to start reading the video clip. It is not possible to play the video clip or query any of its properties (e.g. duration, meta data etc.) until this method has signalled its completion (successful or otherwise) via the callback MvpuoPrepareComplete.

Get the current playback priority. This is used to arbitrate between simultaneous accesses of the sound hardware.

Requests the video controller to redraw the current frame.

Registers for notification, when audio resource is available.

Register to receive notifications of video clip loading/rebuffering.

When a video clip is being streamed in, it may require rebuffering from time to time. This function "switches on" callbacks that report the status of the rebuffering.

The two callbacks that can be sent are MVideoLoadingObserver::MvloLoadingStarted() and MVideoLoadingObserver::MvloLoadingComplete().

Query the rotation that is currently applied to the video image.

Enables or disables audio playback. This function is used to disable audio playback in a video clip to play only the video track. By default audio playback is always enabled if the clip has an audio track.

This method can be called after the video clip has been opened, but only before calling Prepare().

This function quits or exits leaving any of the system wide error codes. Common error codes are listed below.

Set video automatic scaling. When automatic scaling is active, the video picture is scaled automatically to match the video window, based on the scaling type. This variant of SetAutoScaleL() will always center the picture in the window.

Calling SetAutoScaleL() will override any scaling factors set with SetScaleFactorL(). Calling SetScaleFactorL() will disable automatic scaling.

Not all video controllers support automatic scaling.

This function quits or exits leaving any of the system wide error codes. Common error codes are listed below.

Set video automatic scaling. When automatic scaling is active, the video picture is scaled automatically to match the video window, based on the scaling type, and positioned according to the parameters.

Calling SetAutoScaleL() will override any scaling factors set with SetScaleFactorL(). Calling SetScaleFactorL() will disable automatic scaling.

Not all video controller support automatic scaling.

This function quits or exits leaving any of the system wide error codes. Common error codes are listed below.

Sets the current playback balance for the audio track of the video clip.

The balance can be any value between KMMFBalanceMaxLeft and KMMFBalanceMaxRight, the default value being KMMFBalanceCenter.

Selects a region of the video image to be displayed.

Sets the display window. This is used to provide the video controller with an area of the display to render the current video frame.

From Symbian release 9.5 onwards this method is not supported when called on an instance of CVideoPlayerUtility2, and will always leave with KErrNotSupported.

When enabled sets automatic switching of surface to/from external display when it is connected/disconnected from the device.

Automatic switching is enabled by default, but only if the client thread that created this utility has an Active Scheduler installed and the device supports external display switching.

To use this function the client thread must have an Active Scheduler installed otherwise it will leave with KErrNotReady.

Sets the initial screen to be used for the video display.

From Symbian release 9.5 onwards this method is not supported when called on an instance of CVideoPlayerUtility2, and will always leave with KErrNotSupported.

Set video playback velocity relative to the normal video clip speed. This method can be used for fast forward, rewind, and slow-motion playback, depending on the capabilities of the underlying play-controller implementation and the characteristics of the video clip. Velocity set in this call will take effect immediately. Additionally, playback velocity cannot be changed for streamed video. Use GetPlayRateCapabilitiesL() to determine what playback modes are available.

Note that due to performance reasons, it may not be possible to perform fast forward or rewind at the requested speed. If that happens, the play-controller will use the nearest available velocity. This is not considered an error and the method will not leave. User can query velocity in effect by calling PlayVelocityL().

The default playback velocity is 100. Play velocity is persistent across stop play calls on utility. That is SetPlayVelocityL(),call StopL(),then PlayL() will play with the velocity set in most recent call. On opening different file the velocity will default to 100.

This function quits or exits leaving any of the system wide error codes. Common error codes are listed below.

Sets the position within the video clip from where to start playback.

Sets the playback priority.

This is used to arbitrate between multiple objects simultaneously trying to accesses the sound hardware.

Rotates the video image on the screen.

Scales the video image to a specified percentage of its original size.

Enables or disables video playback. This function is used to disable video playback in a video clip to play only the audio track. By default video playback is always enabled if the clip has a video track.

This method can be called after the video clip has been opened, but only before calling Prepare().

This function quits or exits leaving any of the system wide error codes. Common error codes are listed below.

Sets the video frame rate.

Sets the playback volume for the audio track of the video clip.

The volume can be changed before or during playback and is effective immediately. The volume can be set to any value between zero (mute) and the maximum permissible volume (determined using MaxVolume()).

To determine if the current video clip contains an audio track, use AudioEnabledL().

Enables a client application to start the video player using direct screen access (DSA).

From Symbian release 9.5 onwards this method is not supported when called on an instance of CVideoPlayerUtility2, and will always leave with KErrNotSupported.

This function leaves if errors are encountered when trying to start DSA.

Steps the current video playback position forward or backward by a number of frames. Frame step is only available when playback is paused.

Support for frame stepping may depend on the underlying play-controller implementation and the video clip open. Additionally, frame step is typically not available in streamed playback. Use GetPlayRateCapabilitiesL() to query if frame step is currently possible. Application may check the value of the current positon after stepping through several frames by calling PositionL() API.

Implementations may not be able to step exactly the number of frames requested, especially when stepping backwards. If this happens, the play-controller will step to a frame close to the one requested. This is not considered an error.

This function quits or exits leaving any of the system wide error codes. Common error codes are listed below.

Stops playback of the video sample as soon as is possible.

If the video sample is playing, playback is stopped as soon as possible.

If playback is already complete, this function has no effect.

The position is reset to the beginning of the file.

Enables a client application to stop the video player from using direct screen access (DSA).

From Symbian release 9.5 onwards this method is not supported when called on an instance of CVideoPlayerUtility2, and will always leave with KErrNotSupported.

This function leaves if errors are encountered when trying to stop DSA.

Returns the video bit rate.

Queries whether video playback is currently enabled or not. If an error occurs, this function leaves with any of the system wide error codes. Common error codes are listed below.

Returns the video format's MIME type.

Returns the video frame rate in frames/second.

Gets the video frame size.

Returns the current playback volume for the audio track of the video clip.

Waits for the client to resume the play even after the default timer expires. Unless the client completes the play no other client gets notification.