Skip to content

API > VideoPlayer > started


VideoPlayer.started⚓︎

Read-Only

Read-only Property This property is Read-Only

Name Type
started EventHandler

Event callback function requirement⚓︎

Info

This property is an event. It means that you need to add a listener function to it. Here how that function needs to look like.

function(VideoPlayer source);

Parameters⚓︎
Name Type Description
source VideoPlayer The Video Player

Usage⚓︎

--- @type 
local videoplayer;

--- callback function called when event triggers
--- @param videoplayer VideoPlayer
local function CallBack(videoplayer)
    -- code to handle event call back
end


-- Regsiter callback function
videoplayer.started.Add(CallBack);

Description⚓︎

Invoked immediately after Play is called.

Extra Detail⚓︎

The playback engine preparation, if not already done, will start immediately after this is called.