A video player. More...

Public Member Functions
void	Load (string filePath, bool enableAudio=true)
	Load a video.

void	Play ()
	Play the video.

void	Pause ()
	Pause the video.

void	Stop ()
	Stop the video.

Properties
TextureProxy	Texture `[get]`
	The video player's texture.

bool	IsLooping `[get, set]`
	Is the video player looping?

bool	IsReady `[get]`
	Is the video player ready?

bool	IsPlaying `[get]`
	Is the video player playing?

bool	IsPaused `[get]`
	Is the video player paused?

uint	Width `[get]`
	The video player's width.

uint	Height `[get]`
	The video player's height.

Events
EventHandler	OnReady = null
	Event that is raised when the video player is ready to play.

Detailed Description

A video player.

Member Function Documentation

◆ Load()

void SmashHammer.Scripting.VideoPlayerProxy.Load	(	string	filePath,
		bool	enableAudio = `true`
	)

Load a video.

Parameters

filePath	File to load video from.
enableAudio	Set to `true` to enable audio playback; otherwise, `false`.

Property Documentation

◆ Texture

TextureProxy SmashHammer.Scripting.VideoPlayerProxy.Texture

get

The video player's texture.

The texture that this video player renders into.

◆ IsLooping

bool SmashHammer.Scripting.VideoPlayerProxy.IsLooping

getset

Is the video player looping?

true if this video player is looping; otherwise, false.

◆ IsReady

bool SmashHammer.Scripting.VideoPlayerProxy.IsReady

get

Is the video player ready?

true if this video player is ready to play; otherwise, false.

◆ IsPlaying

bool SmashHammer.Scripting.VideoPlayerProxy.IsPlaying

get

Is the video player playing?

true if this video player is playing; otherwise, false.

◆ IsPaused

bool SmashHammer.Scripting.VideoPlayerProxy.IsPaused

get

Is the video player paused?

true if this video player is paused; otherwise, false.

◆ Width

uint SmashHammer.Scripting.VideoPlayerProxy.Width

get

The video player's width.

The width of this video player.

◆ Height

uint SmashHammer.Scripting.VideoPlayerProxy.Height

get

The video player's height.

The height of this video player.

Public Member Functions

Properties

Events