Plugin Specific Event Definitions

The following events are generated by optional Storyboard plugins.

Timer Events

These events are generated by the libgre-timer plugin

timer.[name] Timer Events

Timer events are generated as a result of a timer action.  See documentation on the gra.timer action for further information about configuring timers.

The timer event name will be formatted as timer.[name]  where name is the value set as the name of the timer when the action was defined.

Animation Events

These events are generated by the libgre-animation plugin

gre.animate.complete.[name]

Animation complete events are generated as a result of an animation action.  See documentation on the gra.animation action for further information about configuring animations.

When an animation is completed, an animation complete event will be fired. The event name will be formatted as gre.animate.complete.[name] where name is the value set as the name of the animation when the action was defined.

gre.animate.stop.[name]

Animation stop events are generated as a result of an animation stop action. See documentation on the gra.animate.stop action for further information on terminating animations.

When an animation is stopped, an animation stop event will be fired. The event name will be formatted as gre.animate.stop.[name] where name is the value set as the name of the animation when the action was defined.

Data: (1s0 id)

Gesture Events

These events are generated by the libgre-gesture plugin

gre.gesture.up

Data:

char *gesture_num
int32_t time
                

gre.gesture.down

Data:

char *gesture_num
int32_t time
                

gre.gesture.left

Data:

char *gesture_num
int32_t time
                

gre.gesture.right

Data:

char *gesture_num
int32_t time
                

Screen Display Capture (ScreenDump) Events

These events are generated by the libgre-screen-dump plugin

gre.screendump.complete

A screen dump action has completed.

gre.screendump.failed

Data:

                        char *message
                    

Screen Event Capture/Playback Events

These events are generated by the libgre-animation plugin

gre.capture.started

This event will be generated when the capture-playback plugin begins an event capture session.

gre.capture.stopped

This event will be generated when the capture-playback plugin event capture session is stopped.

gre.playback.started

This event will be generated when the capture-playback plugin begins an event playback session.

gre.playback.complete

This event will be generated when the capture-playback plugin playback is finishes by reaching the end of the playback session.

gre.playback.stopped

This event will be generated when the capture-playback plugin playback session is stopped.

Media Events

gre.media.exit

The media backend application has exited.

Data:

No data payload

gre.media.timeupdate

Emitted when the time has been updated.

Data: "4u1 time_elapsed 1s0 channel_name"

unsigned time_elapsed
char channel_name[MAX_CHANNEL_NAME_LEN + 1]
                        

Where:

time_elapsed

The time that has elapsed during play back

channel_name

The name of the channel that this time event occurred on

gre.media.durationupdate

Emitted when a change in the duration of the media is detected.

Data: "4u1 total_time 1s0 channel_name"

unsigned total_time
char channel_name[MAX_CHANNEL_NAME_LEN + 1]
                		

Where:

total_time

The total duration of the current media file

channel_name

The name of the channel that this time event occurred on

gre.media.statechange

Emitted when the player has changed state, between a paused and playing state.

Data: "1s33 channel_name 1s0 state"

char channel_name[MAX_CHANNEL_NAME_LEN + 1]
char state[1]
                        

Where:

channel_name

The name of the channel that is changing state

state

The new state: “paused” | “playing”

gre.media.complete

Triggered when the named media has played to the end and stopped playing

Data: "1s33 channel 1s0 name"

 char channel_name[MAX_CHANNEL_NAME_LEN + 1]
 char media_name[1]
                        

Where:

channel_name

The name of the channel that has completed playback

media_name

The name of the media stream that completed playback

gre.media.error

Triggered when there was an error playing the media source.

Data: "1s33 channel_name 1s0 error_msg"

char channel_name[MAX_CHANNEL_NAME_LEN + 1]
char error_msg[1]
                        

Where:

channel_name

The name of the channel that received an error

error_msg[1]

The error message

Logger Events

gre.%perf_prefix%.start

Turn on performance logging. Note that %perf_prefix% defaults to "perf", but can be set through the logger plugin options.

Data: "1s0 options"

The options to start the performance logging with.  This can be omitted.
                            Only the performance logging options will be recognized

gre.%perf_prefix%.stop

Turn off performance logging. Note that %perf_prefix% defaults to "perf", but can be set through the logger plugin options.

Data:

No data payload

gre.%perf_prefix%.set.options

Set the options to use for performance logging. Note that %perf_prefix% defaults to "perf", but can be set through the logger plugin options.

Data: "1s0 options"

The options to use with performance logging. Only the performance
                            logging options will be recognized