wiki.sine.space | sinespace

Difference between revisions of "Scripting/SEmbeddedVideo"

From wiki.sine.space
Jump to: navigation, search
m
(Replaced content with "This page has moved to: https://docs.sine.space/v/scripting/client-scripting/components/sembeddedvideo")
 
Line 1: Line 1:
=Members=
+
This page has moved to: https://docs.sine.space/v/scripting/client-scripting/components/sembeddedvideo
 
+
{{ScriptFunction|void|OnStateChange|()|Binds a function to the OnStateChange event which fires every time player changes its state|5=<pre>
+
 
+
function sc()
+
Space.Log("State Changed")
+
end
+
 
+
Space.Host.ExecutingObject.EmbeddedVideo.OnStateChange(sc)
+
</pre>}}
+
 
+
{{ScriptFunction|void|Play|()|If URL is set, plays the video|5=<pre>
+
 
+
Space.Host.ExecutingObject.EmbeddedVideo.Play()
+
</pre>}}
+
 
+
{{ScriptFunction|void|Stop|()|Stops the playback|5=<pre>
+
Space.Host.ExecutingObject.EmbeddedVideo.Stop()
+
</pre>}}
+
 
+
{{ScriptFunction|void|Pause|()|Pauses currently played video|5=<pre>
+
Space.Host.ExecutingObject.EmbeddedVideo.Pause()
+
</pre>}}
+
 
+
{{ScriptFunction|void|Resume|()|If the video is currently paused, it will resume playback|5=<pre>
+
Space.Host.ExecutingObject.EmbeddedVideo.Resume()
+
</pre>}}
+
 
+
{{ScriptFunction|void|SynchorizeUrl|()|Synchorize current video url|5=<pre>
+
Space.Host.ExecutingObject.EmbeddedVideo.SynchorizeUrl()
+
</pre>}}
+
 
+
{{ScriptFunction|void|ClearRenderTexture|()|Clears the Render Texture|5=<pre>
+
Space.Host.ExecutingObject.EmbeddedVideo.ClearRenderTexture()
+
</pre>}}
+
 
+
 
+
 
+
 
+
 
+
=Properties=
+
 
+
 
+
{{ScriptFunction|EmbeddedVideoBaseInternal.EmbeddedVideoState|State|{ get;}|The state player is currently in. You can track state changes through StateChangeEvent.|5= <pre> CurrentVideoState = Space.Host.ExecutingObject.EmbeddedVideo.State</pre>}}
+
 
+
 
+
{{ScriptFunction|string|URL|{ get;set;}|Current URL set for this Player.|5= <pre>CurrentURL = Space.Host.ExecutingObject.EmbeddedVideo.URL</pre>}}
+
 
+
 
+
{{ScriptFunction|SAudioSource|AudioSource|{ get;set;}|Current AudioSource|5= <pre>CurrentAudioSource = Space.Host.ExecutingObject.EmbeddedVideo.AudioSource</pre>}}
+
 
+
 
+
{{ScriptFunction|SResource|OutputTexture|{ get;}||5= <pre>OutputTexture = Space.Host.ExecutingObject.EmbeddedVideo.OutputTexture</pre>}}
+
 
+
 
+
{{ScriptFunction|SResource|Texture|{ get;}|Texture which the player uses to display the video.|5= <pre> Texture = Space.Host.ExecutingObject.EmbeddedVideo.Texture</pre>}}
+
 
+
 
+
{{ScriptFunction|double|Time|{ get;set;}|Current player time. Can be set to move the 'playhead' to the specific position.|5= <pre>Time = Space.Host.ExecutingObject.EmbeddedVideo.Time</pre>}}
+
 
+
 
+
{{ScriptFunction|long|Position|{ get;}|Current Video Frame Position|5= <pre>Position = Space.Host.ExecutingObject.EmbeddedVideo.Position</pre>}}
+
 
+
 
+
{{ScriptFunction|string|UniqueName|{ get;}||5= <pre>UniqueName = Space.Host.ExecutingObject.EmbeddedVideo.UniqueName</pre>}}
+
 
+
 
+
{{ScriptFunction|double|VideoLength|{ get;}|Get the length of the video|5= <pre>VideoLength = Space.Host.ExecutingObject.EmbeddedVideo.VideoLength</pre>}}
+
 
+
 
+
{{ScriptFunction|bool|Loop|{ get;set;}|Whether video is set to loop or not|5= <pre> Space.Host.ExecutingObject.EmbeddedVideo.Loop  = true</pre>}}
+
 
+
 
+
{{ScriptFunction|int|FrameCount|{ get;}|Returns the frame count of the video|5= <pre>FrameCount = Space.Host.ExecutingObject.EmbeddedVideo.FrameCount</pre>}}
+
 
+
 
+
{{ScriptFunction|bool|IsPlaying|{ get;}|Returns whether the video is playing or not|5= <pre>IsPlaying = Space.Host.ExecutingObject.EmbeddedVideo.IsPlaying</pre>}}
+
 
+
 
+
 
+
 
+
 
+
{{Scripting Navbox}}
+

Latest revision as of 05:41, 19 September 2022

This page has moved to: https://docs.sine.space/v/scripting/client-scripting/components/sembeddedvideo