![]() |
MHEG5
22.11.0
|
Implementation of the Ingredient class. More...
#include <string.h>
#include "mh5ingredient.h"
#include "mh5object.h"
#include "mh5final.h"
#include "mh5display.h"
#include "mh5visible.h"
#include "mh5fileorm.h"
#include "mh5streamevent.h"
#include "mh5memory.h"
#include "mh5queue.h"
#include "mh5scene.h"
#include "mh5application.h"
#include "mh5variable.h"
#include "mh5hypertext.h"
#include "mh5listgroup.h"
#include "mh5stream.h"
#include "mh5video.h"
#include "mh5debug.h"
#include "mh5palette.h"
#include "mh5cursorshape.h"
#include "mh5font.h"
#include "mh5program.h"
#include "mh5audio.h"
#include "mh5rtgraphics.h"
#include "mh5slider.h"
#include "mh5dynamiclineart.h"
#include "mh5entryfield.h"
#include "mh5hotspot.h"
#include "mh5pushbutton.h"
#include "mh5switchbutton.h"
#include "mh5profile.h"
#include "mg_api.h"
#include "mg_fontapi.h"
#include "mh5drawtext.h"
Functions | |
void | MHEG5ingredientInit (MHEG5Ingredient *ingredient) |
Initialise a ingredient object with default values. More... | |
void | MHEG5ingredientFree (MHEG5Ingredient *ingredient) |
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. More... | |
void | MHEG5ingredientClone (MHEG5Ingredient *destination, MHEG5Ingredient *source) |
Implementation of the ingredient part of the clone action. More... | |
void | MHEG5ingredientPrepare (MHEG5Ingredient *ingredient) |
Implementation of the Preparation behaviour Inherrited from Root class. More... | |
void | MHEG5ingredientContentPrepare (MHEG5Ingredient *ingredient) |
Implementation of the ContentPrepare behaviour COR.1 6.6: ContentPreparation Apply the following sequence of actions synchronously: More... | |
void | MHEG5ingredientDestruct (MHEG5Ingredient *ingredient) |
Implementation of the Destruction behaviour Execute the following sequence of actions: More... | |
void | MHEG5ingredientActivate (MHEG5Ingredient *ingredient) |
Implementation of Activate behaviour Inherrited from Root class. More... | |
void | MHEG5ingredientDeactivate (MHEG5Ingredient *ingredient) |
Implementation of Deactivate behaviour Inherrited from Root class. More... | |
MHEG5ErrorCode | MHEG5setData (MHEG5Root *target, MHEG5GList *params) |
Implementation of SetData action SetData (NewContent) Set the Content attribute of the target Ingredient to NewContent. Provisions of use: The Target object shall be an available Ingredient object. The ContentHook of the target Ingredient object shall be encoded. Data included or referenced by NewContent shall have the encoding format determined by ContentHook of the target Ingredient. If Content is currently set to included data, NewContent shall be set or refer to included data. If Content is currently set to a reference to an external data source, then NewContent shall be set or refer to a reference to an external data source. COR1: Execute the following sequence of actions: More... | |
MHEG5ErrorCode | MHEG5clone (MHEG5Root *target, MHEG5GList *params) |
Implementation of the Clone action Clone (CloneRefVar) If the engine supports the Cloning option the effect of this action is described below. Engines that do not support the Cloning option shall ignore this action. This action copies the Target adding the copy to the same group that contains the Target using a unique ObjectReference obtained from the engine. The ObjectReference referring to the copy is returned in the ObjectRefVariable referenced by CloneRefVar. Execute the following sequence of actions: More... | |
MHEG5ErrorCode | MHEG5preload (MHEG5Root *target, MHEG5GList *params) |
Implementation of the Preload action Preload Prepares an Ingredient and provides a hint to the MHEG-5 engine to prepare the content data of an Ingredient for future use. Execute the following sequence of actions: More... | |
MHEG5ErrorCode | MHEG5unload (MHEG5Root *target, MHEG5GList *params) |
Implementation of the Unload action Unload Destroys an Ingredient and provides a hint to the MHEG-5 engine to free resources allocated to an Ingredient. Execute the following sequence of actions: More... | |
Implementation of the Ingredient class.
MHEG5ErrorCode MHEG5clone | ( | MHEG5Root * | target, |
MHEG5GList * | params | ||
) |
Implementation of the Clone action Clone (CloneRefVar) If the engine supports the Cloning option the effect of this action is described below. Engines that do not support the Cloning option shall ignore this action. This action copies the Target adding the copy to the same group that contains the Target using a unique ObjectReference obtained from the engine. The ObjectReference referring to the copy is returned in the ObjectRefVariable referenced by CloneRefVar. Execute the following sequence of actions:
target | target object for this action |
params | Action parameters |
void MHEG5ingredientActivate | ( | MHEG5Ingredient * | ingredient | ) |
Implementation of Activate behaviour Inherrited from Root class.
ingredient | Ingredient to activate |
void MHEG5ingredientClone | ( | MHEG5Ingredient * | destination, |
MHEG5Ingredient * | source | ||
) |
Implementation of the ingredient part of the clone action.
destination | Ingredient object to clone to |
source | Ingredient object to clone from |
void MHEG5ingredientContentPrepare | ( | MHEG5Ingredient * | ingredient | ) |
Implementation of the ContentPrepare behaviour COR.1 6.6: ContentPreparation Apply the following sequence of actions synchronously:
ingredient | Ingredient to prepare |
void MHEG5ingredientDeactivate | ( | MHEG5Ingredient * | ingredient | ) |
Implementation of Deactivate behaviour Inherrited from Root class.
ingredient | Ingredient to deactivate |
void MHEG5ingredientDestruct | ( | MHEG5Ingredient * | ingredient | ) |
Implementation of the Destruction behaviour Execute the following sequence of actions:
ingredient | Ingredient to destruct |
void MHEG5ingredientFree | ( | MHEG5Ingredient * | ingredient | ) |
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.
ingredient | Pointer to object to free. |
void MHEG5ingredientInit | ( | MHEG5Ingredient * | ingredient | ) |
Initialise a ingredient object with default values.
ingredient | Pointer to object to initialise. |
void MHEG5ingredientPrepare | ( | MHEG5Ingredient * | ingredient | ) |
Implementation of the Preparation behaviour Inherrited from Root class.
ingredient | Ingredient to prepare |
MHEG5ErrorCode MHEG5preload | ( | MHEG5Root * | target, |
MHEG5GList * | params | ||
) |
Implementation of the Preload action Preload Prepares an Ingredient and provides a hint to the MHEG-5 engine to prepare the content data of an Ingredient for future use. Execute the following sequence of actions:
MHEG5PROFILE_UK1_06
MHEG5ErrorCode MHEG5setData | ( | MHEG5Root * | target, |
MHEG5GList * | params | ||
) |
Implementation of SetData action SetData (NewContent) Set the Content attribute of the target Ingredient to NewContent. Provisions of use: The Target object shall be an available Ingredient object. The ContentHook of the target Ingredient object shall be encoded. Data included or referenced by NewContent shall have the encoding format determined by ContentHook of the target Ingredient. If Content is currently set to included data, NewContent shall be set or refer to included data. If Content is currently set to a reference to an external data source, then NewContent shall be set or refer to a reference to an external data source. COR1: Execute the following sequence of actions:
target | target object for this action |
params | Action parameters |
MHEG5ErrorCode MHEG5unload | ( | MHEG5Root * | target, |
MHEG5GList * | params | ||
) |
Implementation of the Unload action Unload Destroys an Ingredient and provides a hint to the MHEG-5 engine to free resources allocated to an Ingredient. Execute the following sequence of actions: