CustomEventInstance

Generic typessource

Handle to an FMOD event instance. Can be used to start and stop an event, or set the events parameters. Once you are done with an event instance and no longer need to change its playback state or parameters, you should call CustomEventInstance:release() so the event is marked for release and released when it stops playing to free resources. Generally though, it is best practice to call CustomEventInstance:release() immediately after CustomEventInstance:start() unless you want to play the event instance multiple times or explicitly start and stop it later.

Methods

get_parameter_by_id

function CustomEventInstance:get_parameter_by_id(id: ParameterId): number?

id: ParameterId

Returns number? (may be nil)

source

get_parameter_by_name

function CustomEventInstance:get_parameter_by_name(name: string): number?

name: string

Returns number? (may be nil)

source

get_pause

function CustomEventInstance:get_pause(): boolean?

Returns boolean? (may be nil)

source

get_pitch

function CustomEventInstance:get_pitch(): number?

Returns number? (may be nil)

source

get_playback_state

function CustomEventInstance:get_playback_state(): integer?

Returns integer? (may be nil)

source

get_timeline_position

function CustomEventInstance:get_timeline_position(): integer?

Returns integer? (may be nil)

source

get_volume

function CustomEventInstance:get_volume(): number?

Returns number? (may be nil)

source

is_valid

function CustomEventInstance:is_valid(): boolean

Returns boolean

source

key_off

function CustomEventInstance:key_off(): boolean

Returns boolean

source

release

function CustomEventInstance:release(): boolean

Returns boolean

source

set_parameter_by_id

function CustomEventInstance:set_parameter_by_id(id: ParameterId, value: number): boolean

id: ParameterId

value: number

Returns boolean

function CustomEventInstance:set_parameter_by_id(id: ParameterId, value: number, ignoreseekspeed: boolean): boolean

id: ParameterId

value: number

ignoreseekspeed: boolean

Returns boolean

source

set_parameter_by_id_with_label

function CustomEventInstance:set_parameter_by_id_with_label(id: ParameterId, label: string): boolean

id: ParameterId

label: string

Returns boolean

function CustomEventInstance:set_parameter_by_id_with_label(id: ParameterId, label: string, ignoreseekspeed: boolean): boolean

id: ParameterId

label: string

ignoreseekspeed: boolean

Returns boolean

source

set_parameter_by_name

function CustomEventInstance:set_parameter_by_name(name: string, value: number): boolean

name: string

value: number

Returns boolean

function CustomEventInstance:set_parameter_by_name(name: string, value: number, ignoreseekspeed: boolean): boolean

name: string

value: number

ignoreseekspeed: boolean

Returns boolean

source

set_parameter_by_name_with_label

function CustomEventInstance:set_parameter_by_name_with_label(name: string, label: string): boolean

name: string

label: string

Returns boolean

function CustomEventInstance:set_parameter_by_name_with_label(name: string, label: string, ignoreseekspeed: boolean): boolean

name: string

label: string

ignoreseekspeed: boolean

Returns boolean

source

set_pause

function CustomEventInstance:set_pause(pause: boolean): boolean

pause: boolean

Returns boolean

source

set_pitch

function CustomEventInstance:set_pitch(pitch: number): boolean

pitch: number

Returns boolean

source

set_timeline_position

function CustomEventInstance:set_timeline_position(position: integer): boolean

position: integer

Returns boolean

source

set_volume

function CustomEventInstance:set_volume(volume: number): boolean

volume: number

Returns boolean

source

start

function CustomEventInstance:start(): boolean

Returns boolean

source

stop

function CustomEventInstance:stop(): boolean

Returns boolean

function CustomEventInstance:stop(mode: integer): boolean

mode: integer

Returns boolean

source