reckfellENGINE

VideoStream

Video-source resource creating an independent playback object.

On this page
class VideoStreamReckfellSharpInherits Resource

VideoStream describes the source; VideoStreamPlayback owns decoding and playback position. Use an existing format implementation or a subclass implementing _InstantiatePlayback. Assigning File on a base resource does not turn it into a decoder.

For a custom implementation, return a new valid playback for each request so players do not share position/state.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

VideoStreamConstructor
# VideoStream
C#
public VideoStream();

Creates a base source resource. A file needs a concrete decoder or _InstantiatePlayback implementation.

Properties1

FileProperty
# File
C#
public string File { get; set; }

Source path used by the decoder implementation. The setter emits Changed and may recreate playback in players using the resource. Does not validate/transcode an arbitrary file.

Methods3

GetFilestring
# GetFile
C#
public string GetFile();

Source path used by the decoder implementation. The setter emits Changed and may recreate playback in players using the resource. Does not validate/transcode an arbitrary file.

Returns string

Source path used by the decoder implementation. The setter emits Changed and may recreate playback in players using the resource. Does not validate/transcode an arbitrary file.

SetFilevoid
# SetFile
C#
public void SetFile(string file);

Source path used by the decoder implementation. The setter emits Changed and may recreate playback in players using the resource. Does not validate/transcode an arbitrary file.

Parameters
NameTypeDefault
filestring—
file

Supported source path rather than a guarantee of format support.

_InstantiatePlaybackVideoStreamPlayback
# _InstantiatePlayback
C#
public virtual VideoStreamPlayback _InstantiatePlayback();

Return a new valid VideoStreamPlayback for this request. null is not success. It owns decoding state; do not return one shared instance to multiple players.

Returns VideoStreamPlayback

Return a new valid VideoStreamPlayback for this request. null is not success. It owns decoding state; do not return one shared instance to multiple players.

Reckfell Engine documentationBack to top ↑
QUICK LINKSGetting startedEntity hierarchyC# & .NET 10Scenes and prefabs
Reckfell guides and full API K
reckfellENGINE
RECKFELL ACCOUNT

Sign in

Sign in to your Reckfell account.

One account for the entire Reckfell platform.