Implement generic MHEG5-display functions - independent from the OSD These are generic functions used by the MHEG5 engine to manage it's display. These functions are the direct API between the |OSD| and the MHEG5-classes. More...

#include "mh5visible.h"
#include "mh5bitmap.h"
#include "mh5lineart.h"
#include "mh5rectangle.h"
#include "mh5stream.h"
#include "mh5audio.h"
#include "mh5video.h"
#include "mh5rtgraphics.h"

Defines
#define	MHEG5displayShow(v) MHEG5displayVisUpd(v, 0)
#define	MHEG5displayHide(v) MHEG5displayVisUpd(v, 1)
#define	MHEG5displayRedraw(v) if ((v)->ingredient.root.runningStatus) MHEG5displayVisUpd(v, 2);
Functions
void	MHEG5displayClear (void)
	<Function description>="">
void	MHEG5displayVisUpd (MHEG5Visible *visible, U8BIT upd)
void	MHEG5displayShowAll (void)
	Redisplay all active visible objects. AKD: Optimised 12/5/99.
void	MHEG5displayResume (void)
void	MHEG5groupClearImages (MHEG5Root *group)
void	MHEG5groupRedraw (MHEG5Root *group)
void	MHEG5displayUpdate (void)
	Update the display, redrawing any visible objects that are in the dirty rectangle.
void	MHEG5displayLockStreams (void)
	Lock streams, disallow any stream updates.
void	MHEG5displayUnlockStreams (void)
	Unlock streams, allow stream updates.
OSDColor	MHEG5displayColour (MHEG5Colour *colour)
	Convert Generic Colour value to OSD specific value. If the generic colour is encoded as a string it is converted to an OSD representation. The OSD representation is then cached as an integer value.
void	MHEG5displayAudioPlay (MHEG5Audio *audio)
	Begin playback of the specified audio object.
void	MHEG5displayAudioStop (void)
	Stops playback of the audio media decoder.
void	MHEG5displaySetVolume (MHEG5Int volume)
	Volume Control.
void	MHEG5displayVideoPlay (MHEG5Video *video)
	Begin playback of the specified video object.
void	MHEG5displayVideoStop (void)
	Stops playback of the video media decoder.
void	MHEG5displayStreamPlay (MHEG5Stream *stream)
	Begin playback of all active components in the specifed stream object.
void	MHEG5displayStreamStop (MHEG5Stream *stream)
	Stops playback of all active component of the specified stream object.
void	MHEG5displayIFrameStart (MHEG5Bitmap *bitmap)
	Start displaying an I-Frame.
void	MHEG5displayIFrameStop (void)
	Stop displaying an I-Frame.
void	MHEG5displayResetStreamDecoders (BOOLEAN update)
	Reset all media decoders to default values. This is used when the MHEG-5 engine is terminated, or the last application quits.
void	MHEG5displayVideoPositionUpdate (void)
void	MHEG5notifyVideoStarted (void)
void	MHEG5notifyVideoStopped (void)
void	MHEG5notifyAudioStarted (BOOLEAN isClip)
void	MHEG5notifyAudioStopped (BOOLEAN isClip)
void	MHEG5displayVideoDestroy (MHEG5Video *video)
void	MHEG5displayAudioDestroy (MHEG5Audio *audio)
void	MHEG5displayIframeDestroy (MHEG5Bitmap *iframe)
void	MHEG5displayStreamUpdate (void)
void	MHEG5displayRefreshStreams (U16BIT service_id)
U16BIT	MHEG5GetVideoSid (void)
U16BIT	MHEG5GetAudioSid (void)

Detailed Description

Implement generic MHEG5-display functions - independent from the OSD These are generic functions used by the MHEG5 engine to manage it's display. These functions are the direct API between the |OSD| and the MHEG5-classes.

Date:: 05/02/2002

Author:: R.Freeman

Function Documentation

void MHEG5displayAudioPlay ( MHEG5Audio * audio )

Begin playback of the specified audio object.

Parameters:

audio Audio object to play

Returns:: void

void MHEG5displayAudioStop ( void )

Stops playback of the audio media decoder.

Returns:: void

Parameters:

immediate Stop media decoder immediately, else wait until the next time that the display is updated.

Returns:: void

void MHEG5displayClear ( void )

Returns:: <Return value>="">; <Return value>=""> Clear the Display.to the desktop colour; void

OSDColor MHEG5displayColour ( MHEG5Colour * colour )

Convert Generic Colour value to OSD specific value. If the generic colour is encoded as a string it is converted to an OSD representation. The OSD representation is then cached as an integer value.

Parameters:

colour Generic colour value. This describes the colour as either a string or integer value.

Returns:: OSDColor representation of the colour

void MHEG5displayIFrameStart ( MHEG5Bitmap * bitmap )

Start displaying an I-Frame.

Parameters:

bitmap Pointer to bitmap object

Returns:: void

void MHEG5displayIFrameStop ( void )

Stop displaying an I-Frame.

Returns:: void

void MHEG5displayLockStreams ( void )

Lock streams, disallow any stream updates.

Returns:: void

void MHEG5displayResetStreamDecoders ( BOOLEAN update )

Reset all media decoders to default values. This is used when the MHEG-5 engine is terminated, or the last application quits.

Returns:: void

void MHEG5displaySetVolume ( MHEG5Int volume )

Volume Control.

Parameters:

MHEG5Int volume

Returns:: void

void MHEG5displayShowAll ( void )

Redisplay all active visible objects. AKD: Optimised 12/5/99.

Returns:: void

void MHEG5displayStreamPlay ( MHEG5Stream * stream )

Begin playback of all active components in the specifed stream object.

Parameters:

stream Stream object to play components of

Returns:: void

void MHEG5displayStreamStop ( MHEG5Stream * stream )

Stops playback of all active component of the specified stream object.

Parameters:

stream Stream object to stop playing component of.

Returns:: void

Parameters:

stream	Stream object to stop playing component of.
immediate	Stop media decoders immediately, else wait until the next time that the display is updated.

Returns:: void

void MHEG5displayUnlockStreams ( void )

Unlock streams, allow stream updates.

Returns:: void

void MHEG5displayUpdate ( void )

Update the display, redrawing any visible objects that are in the dirty rectangle.

Parameters:

visible Visible object to redraw

Returns:: void

void MHEG5displayVideoPlay ( MHEG5Video * video )

Begin playback of the specified video object.

Parameters:

video Video object to play

Returns:: void

void MHEG5displayVideoStop ( void )

Stops playback of the video media decoder.

Returns:: void

Parameters:

immediate Stop media decoder immediately, else wait until the next time that the display is updated.

Returns:: void

Defines

Functions

Detailed Description

Function Documentation