source/classes/src/mh5audio.c File Reference

Implement the MHEG5 Audio Class Description Defines the attributes and behaviour of an elementary audio stream of a Stream multiplex. The Audio object shall be a StreamComponent of a Stream object. Base class: Presentable Subclasses: None Status: Concrete class. More...

#include "mh5audio.h"
#include "mh5application.h"
#include "mh5object.h"
#include "mh5variable.h"
#include "mh5memory.h"
#include "mh5display.h"
#include "mh5queue.h"
#include "mh5debug.h"

Functions
void	MHEG5audioInit (MHEG5Audio *audio)
	<Function description>="">
void	MHEG5audioFree (MHEG5Audio *audio)
	Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed.
void	MHEG5audioPrepare (MHEG5Audio *audio)
	Apply the preparation behaviour off the audio class Apply the preparation behaviour off the audio class. As this class has no own preparation behaviour this function just invokes the preparation behaviour from the base class.
void	MHEG5audioActivate (MHEG5Audio *audio)
	Apply the activation behaviour off the audio class. Apply the activation behaviour of the base class, set the running status to true and set the initial volume.
void	MHEG5audioDeactivate (MHEG5Audio *audio)
	Apply the deactivation behaviour off the audio class. As this class has no own deactivation behaviour this function just invokes the deactivation behaviour from the base class.
void	MHEG5audioDestruct (MHEG5Audio *audio)
	Destruct an audio object.
MHEG5ErrorCode	MHEG5setVolume (MHEG5Root *target, MHEG5GList *params)
	Change the volume of an audio. Implementation of the SetVolume (NewVolume) action of the audio class.
MHEG5ErrorCode	MHEG5getVolume (MHEG5Root *target, MHEG5GList *params)
	Returns the volume of an Audio. Implementation of the GetVolume (VolumeVar) action of the audio class.

---

Detailed Description

Implement the MHEG5 Audio Class Description Defines the attributes and behaviour of an elementary audio stream of a Stream multiplex. The Audio object shall be a StreamComponent of a Stream object. Base class: Presentable Subclasses: None Status: Concrete class.

Date:

22/04/2002

Author:

iwillis

---

Function Documentation

void MHEG5audioActivate

(

MHEG5Audio *

audio

)

Apply the activation behaviour off the audio class. Apply the activation behaviour of the base class, set the running status to true and set the initial volume.

Parameters:

MHEG5Audio

*audio

Returns:

void

void MHEG5audioDeactivate

(

MHEG5Audio *

audio

)

Apply the deactivation behaviour off the audio class. As this class has no own deactivation behaviour this function just invokes the deactivation behaviour from the base class.

Parameters:

MHEG5Audio

*audio

Returns:

void

void MHEG5audioDestruct

(

MHEG5Audio *

audio

)

Destruct an audio object.

Parameters:

MHEG5Audio

*audio

Returns:

void

void MHEG5audioFree

(

MHEG5Audio *

audio

)

Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed.

Parameters:

audio

Pointer to object to free.

Returns:

Void

void MHEG5audioInit

(

MHEG5Audio *

audio

)

<Function description>="">

Returns:

<Return value>=""> Initialise an audio object with default values.

Parameters:

audio

Pointer to object to initialise.

Returns:

Void

void MHEG5audioPrepare

(

MHEG5Audio *

audio

)

Apply the preparation behaviour off the audio class Apply the preparation behaviour off the audio class. As this class has no own preparation behaviour this function just invokes the preparation behaviour from the base class.

Parameters:

MHEG5Audio

*audio

Returns:

void

MHEG5ErrorCode MHEG5getVolume	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

Returns the volume of an Audio. Implementation of the GetVolume (VolumeVar) action of the audio class.

Parameters:

MHEG5Root	*target
MHEG5GList	*params

Returns:

MHEG5ErrorCode MHEG5ErrorCode

MHEG5ErrorCode MHEG5setVolume	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

Change the volume of an audio. Implementation of the SetVolume (NewVolume) action of the audio class.

Parameters:

MHEG5Root	*target
MHEG5GList	*params

Returns:

MHEG5ErrorCode MHEG5ErrorCode