gobj_play()

The gobj_play() function transitions a GObj into the playing state, invoking its mt_play method if defined. If the GObj is not already running, it will be started unless the gcflag_required_start_to_play flag is set.

C

Prototype

int gobj_play(
    hgobj gobj
);

Parameters

Key	Type	Description
gobj	hgobj	Handle to the GObj instance to be played.

---

Return Value

Returns 0 on success, or a negative value if an error occurs.

Notes

[‘If the GObj is already playing, a warning is logged.’, ‘If the GObj is disabled, it cannot be played.’, ‘If the GObj is not running, it will be started unless gcflag_required_start_to_play is set.’, “If the GObj’s mt_play method is defined, it will be invoked.”]

JS

Prototype

// Not applicable in JS

Python

Prototype

# Not applicable in Python

Examples

C

// TODO C examples

JS

// TODO JS examples

Python

# TODO Python examples