VideoPlayer.frameReady

"Read-Only"

This property is Read-Only

Name	Type
frameReady	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, number frameIdx);

Parameters

Name	Type	Description
source	VideoPlayer	The Video Player
frameIdx	number	Frame Index

Usage

--- @type 
local videoplayer;

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


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

Description

Invoked when a new frame is ready.

Extra Detail

This is likely to tax the CPU so this callback must be explicitly enabled through the VideoPlayer.frameReadyEventsEnabled property.