FalcoEngine.VideoPlayer Class Reference

Inheritance diagram for FalcoEngine.VideoPlayer:

Public Member Functions
delegate void	PlaybackEvent (VideoPlayer sender)
void	Play ()
	Play current audio clip More...
void	Pause ()
	Pause playing More...
void	Resume ()
	Resume playing More...
void	Stop ()
	Stop playing More...
int	GetTotalLength ()
	Get total length in seconds More...
int	GetPlaybackPosition ()
	Get current playback position in seconds More...
void	SetPlaybackPosition (int seconds)
	Set current playback position in seconds More...

Properties
VideoClip	videoClip [getset]
	Get or set the video clip for this video player More...
bool	isPlaying [get]
	Returns if this video player is playing More...
bool	isPaused [get]
	Returns if this video player is paused More...
bool	loop [getset]
	Return or set whether the video player replays after it finishes or not More...
bool	playOnStart [getset]
	Returns or sets if video player should start playing after scene is loaded More...
Texture	texture [get]
	Returns current frame as a texture More...
Properties inherited from FalcoEngine.Component
bool	enabled [getset]
	Enable or disable this component More...
GameObject	gameObject [get]
	Get game object at which this component is attached More...
bool	isUiComponent [get]
	Returns if this component is derived from UIElement (or this is a canvas) or not More...

Events
PlaybackEvent	onEnded

Additional Inherited Members
Protected Member Functions inherited from FalcoEngine.Component
	Component ()

Detailed Description

Definition at line 7 of file VideoPlayer.cs.

Member Function Documentation

GetPlaybackPosition()

int FalcoEngine.VideoPlayer.GetPlaybackPosition

(

)

Get current playback position in seconds

Returns

GetTotalLength()

int FalcoEngine.VideoPlayer.GetTotalLength

(

)

Get total length in seconds

Returns

Pause()

void FalcoEngine.VideoPlayer.Pause

(

)

Pause playing

Play()

void FalcoEngine.VideoPlayer.Play

(

)

Play current audio clip

PlaybackEvent()

delegate void FalcoEngine.VideoPlayer.PlaybackEvent

(

VideoPlayer

sender

)

Resume()

void FalcoEngine.VideoPlayer.Resume

(

)

Resume playing

SetPlaybackPosition()

void FalcoEngine.VideoPlayer.SetPlaybackPosition

(

int

seconds

)

Set current playback position in seconds

Parameters

seconds

Stop()

void FalcoEngine.VideoPlayer.Stop

(

)

Stop playing

Property Documentation

isPaused

bool FalcoEngine.VideoPlayer.isPaused

get

Returns if this video player is paused

Definition at line 27 of file VideoPlayer.cs.

isPlaying

bool FalcoEngine.VideoPlayer.isPlaying

get

Returns if this video player is playing

Definition at line 22 of file VideoPlayer.cs.

loop

bool FalcoEngine.VideoPlayer.loop

getset

Return or set whether the video player replays after it finishes or not

Definition at line 32 of file VideoPlayer.cs.

playOnStart

bool FalcoEngine.VideoPlayer.playOnStart

getset

Returns or sets if video player should start playing after scene is loaded

Definition at line 37 of file VideoPlayer.cs.

texture

Texture FalcoEngine.VideoPlayer.texture

get

Returns current frame as a texture

Definition at line 42 of file VideoPlayer.cs.

videoClip

VideoClip FalcoEngine.VideoPlayer.videoClip

getset

Get or set the video clip for this video player

Definition at line 17 of file VideoPlayer.cs.

Event Documentation

onEnded

PlaybackEvent FalcoEngine.VideoPlayer.onEnded

Definition at line 12 of file VideoPlayer.cs.

---

The documentation for this class was generated from the following file:

• API/Components/Other/VideoPlayer.cs