1.Quick Glance
Video Functions are GPE functions used to get data on a videoresource. They are also used to play, pause or stop video and video groups.
Was this helpful?
2.Video Functions
void GPE.loop_video( int videoId)
Begins playing an video resource in a constant loop. Useful for background music and ambient noises.
Scope: GPE
Return type : void
Parameters:
- int videoId– an integer of an video resource(aka msc_level1). If undefined, null or non-number based this function does nothing.
void GPE.pause_video( int videoId)
Pauses the video resource with the matching id from playing.
Scope: GPE
Return type : void
Parameters:
- int videoId– an integer of an video resource(aka msc_level1). If undefined, null or non-number based this function does nothing.
void GPE.pause_video_group( String videoGroupId)
Pauses all video resources with the matching group id from playing.
Scope: GPE
Return type : void
Parameters:
- String videoGroupId– The name of the video group. Typically created in editor.
void GPE.play_video( int videoId, bool loops)
Begins playing an video resource . If loops is set to true it then sets it to a constant loop(Useful for background music and ambient noises).
Scope: GPE
Return type : void
Parameters:
- int videoId– an integer of an video resource(aka msc_level1). If undefined, null or non-number based this function does nothing.
- bool loops – select true if you wish to keep the video playing in repeat after the first successful play.
void GPE.stop_video( int videoId)
Stops the video resource with the matching id from playing.
Scope: GPE
Return type : void
Parameters:
- int videoId– an integer of an video resource(aka msc_level1). If undefined, null or non-number based this function does nothing.
void GPE.stop_video_group( String videoGroupId)
Stops all video resources with the matching group id from playing.
Scope: GPE
Return type : void
Parameters:
- String videoGroupId– The name of the video group. Typically created in editor.
void GPE.video_pause_all( )
This function systematically pauses all current videos from playing.
Scope: GPE
Return type : void
Parameters: none
void GPE.video_play( int videoId, bool loops)
Begins playing an video resource . If loops is set to true it then sets it to a constant loop(Useful for background music and ambient noises).
Scope: GPE
Return type : void
Parameters:
- int videoId– an integer of an video resource(aka msc_level1). If undefined, null or non-number based this function does nothing.
- bool loops – select true if you wish to keep the video playing in repeat after the first successful play.
bool GPE.video_playing( int videoId)
Returns true or false if the video is playing.
Scope: GPE
Return type : bool
Parameters:
- int videoId– an integer of an video resource(aka msc_level1). If undefined, null or non-number based this function returns false.
void GPE.video_stop_all( )
This function systematically stops all current videos from playing.
Scope: GPE
Return type : void
Parameters: none
3.Related Pages
- Video Editor – quick overview of managing videos in GPE’s editor..
- Video– Information about how GPE handles videos.
- The Editor – Information on how to utilize GPE’s editor.
- Coding with GPE – A general tutorial on how to code in GPE.
- Function Directory – The directory to learn about functions on a categorical basis.