Component:VideoPlayerInterface: Difference between revisions

From Resonite Wiki
← Older edit
Visual
add template
add info
 
Line 3: Line 3:
|Name=Video Player Interface
|Name=Video Player Interface
}}
}}
{{stub}}
The '''VideoPlayerInterface''' component is a [[Favorites|favoritable]] item that is used to specify the UI elements of a custom [[Video Player]].


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|ItemName|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv0=true|
|ItemName|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv0=true| The name of this favoritable item.
|SpawningUser|UserRef|
|SpawningUser|UserRef| The user that spawned this favoritable item.
|SpawningUserID|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv2=true|
|SpawningUserID|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv2=true| The field containing the ID of the user that spawned this favoritable item.
|IsInstance|Bool|
|IsInstance|Bool| Whether this item is an instance.
|URL|'''[[Type:IField`1|IField`1]]<[[Type:Uri|Uri]]>'''|TypeAdv4=true|
|URL|'''[[Type:IField`1|IField`1]]<[[Type:Uri|Uri]]>'''|TypeAdv4=true| The field to fill with the URL of the imported video asset.
|Stream|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv5=true|
|Stream|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv5=true| The field to fill with whether this video player is showing stream.
|VideoClip|'''[[Type:AssetRef`1|AssetRef`1]]<[[Type:VideoTexture|VideoTexture]]>'''|TypeAdv6=true|
|VideoClip|'''[[Type:AssetRef`1|AssetRef`1]]<[[Type:VideoTexture|VideoTexture]]>'''|TypeAdv6=true| The field to fill with what the video being displayed is.
|VideoClipTexture|'''[[Type:AssetRef`1|AssetRef`1]]<[[Type:ITexture2D|ITexture2D]]>'''|TypeAdv7=true|
|VideoClipTexture|'''[[Type:AssetRef`1|AssetRef`1]]<[[Type:ITexture2D|ITexture2D]]>'''|TypeAdv7=true| The field to fill (Usually a material texture field) with the showing video texture.
|AspectRatio|'''[[Type:IField`1|IField`1]]<[[Type:Float|Float]]>'''|TypeAdv8=true|
|AspectRatio|'''[[Type:IField`1|IField`1]]<[[Type:Float|Float]]>'''|TypeAdv8=true| The field to fill with what the video's aspect ratio is.
|DefaultVideoClip|{{RootFieldType|AssetRef`1|[[Type:VideoTexture|VideoTexture]]}}|TypeAdv9=true|
|DefaultVideoClip|{{RootFieldType|AssetRef`1|[[Type:VideoTexture|VideoTexture]]}}|TypeAdv9=true| The default video texture to use if one isn't filled in.
|StereoRenderingEnabled|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv10=true|
|StereoRenderingEnabled|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv10=true| The field to fill with whether the video is a stero video (3D)
|StereoLayout|'''[[Type:IField`1|IField`1]]<[[Type:StereoLayout|StereoLayout]]>'''|TypeAdv11=true|
|StereoLayout|'''[[Type:IField`1|IField`1]]<[[Type:StereoLayout|StereoLayout]]>'''|TypeAdv11=true| The field to fill with the kind of stero image layout the image has.
|StereoTransformLeft|'''[[Type:IField`1|IField`1]]<[[Type:Float4|Float4]]>'''|TypeAdv12=true|
|StereoTransformLeft|'''[[Type:IField`1|IField`1]]<[[Type:Float4|Float4]]>'''|TypeAdv12=true| The field to fill with what the rectangle area for the left eye should be.
|StereoTransformRight|'''[[Type:IField`1|IField`1]]<[[Type:Float4|Float4]]>'''|TypeAdv13=true|
|StereoTransformRight|'''[[Type:IField`1|IField`1]]<[[Type:Float4|Float4]]>'''|TypeAdv13=true| The field to fill with what the rectangle area for the right eye should be.
|StereoTransformScaleLeft|'''[[Type:IField`1|IField`1]]<[[Type:Float2|Float2]]>'''|TypeAdv14=true|
|StereoTransformScaleLeft|'''[[Type:IField`1|IField`1]]<[[Type:Float2|Float2]]>'''|TypeAdv14=true| The field to fill with what the UV scale for the left eye should be.
|StereoTransformOffsetLeft|'''[[Type:IField`1|IField`1]]<[[Type:Float2|Float2]]>'''|TypeAdv15=true|
|StereoTransformOffsetLeft|'''[[Type:IField`1|IField`1]]<[[Type:Float2|Float2]]>'''|TypeAdv15=true| The field to fill with what the UV offset for the left eye should be.
|StereoTransformScaleRight|'''[[Type:IField`1|IField`1]]<[[Type:Float2|Float2]]>'''|TypeAdv16=true|
|StereoTransformScaleRight|'''[[Type:IField`1|IField`1]]<[[Type:Float2|Float2]]>'''|TypeAdv16=true| The field to fill with what the UV scale for the right eye should be.
|StereoTransformOffsetRight|'''[[Type:IField`1|IField`1]]<[[Type:Float2|Float2]]>'''|TypeAdv17=true|
|StereoTransformOffsetRight|'''[[Type:IField`1|IField`1]]<[[Type:Float2|Float2]]>'''|TypeAdv17=true| The field to fill with what the UV offset for the right eye should be.
|PanoramicRenderingEnabled|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv18=true|
|PanoramicRenderingEnabled|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv18=true| The field to fill with whether the video is a 360 video
|PanoramicHorizontalFOV|'''[[Type:IField`1|IField`1]]<[[Type:Float|Float]]>'''|TypeAdv19=true|
|PanoramicHorizontalFOV|'''[[Type:IField`1|IField`1]]<[[Type:Float|Float]]>'''|TypeAdv19=true| The field to fill with the video's horizontal 360 video FOV.
|PanoramicVerticalFOV|'''[[Type:IField`1|IField`1]]<[[Type:Float|Float]]>'''|TypeAdv20=true|
|PanoramicVerticalFOV|'''[[Type:IField`1|IField`1]]<[[Type:Float|Float]]>'''|TypeAdv20=true| The field to fill with the video's vertical 360 video FOV.
|PanoramicProjection|'''[[Type:IField`1|IField`1]]<[[Type:PanoramicProjection|PanoramicProjection]]>'''|TypeAdv21=true|
|PanoramicProjection|'''[[Type:IField`1|IField`1]]<[[Type:PanoramicProjection|PanoramicProjection]]>'''|TypeAdv21=true| The field to fill with what the video's panoramic texture arrangement is.
}}
}}


== Behavior ==
== Usage ==
Use either the existing Resonite video player under [[Resonite Essentials]] or make a UI by attaching the component and making one from scratch. Then save the item with this component to the inventory and [[Favorites|favorite]] it so it becomes the default player upon restarting.


== Examples ==
== Examples ==
The default Resonite player that is part of the user's default [[Favorites]]


== See Also ==
== See Also ==
{{Template:EntityInterface SeeAlso}}
{{Template:EntityInterface SeeAlso}}
* [[Video Player]]


[[Category:Components:Utility:Entity Interfaces{{#translation:}}|Video Player Interface]]
[[Category:Components:Utility:Entity Interfaces{{#translation:}}|Video Player Interface]]
[[Category:Components{{#translation:}}|Video Player Interface]]
[[Category:Components{{#translation:}}|Video Player Interface]]
[[Category:ComponentStubs]]

Latest revision as of 20:19, 6 February 2025

Component image 
Video Player Interface component as seen in the Scene Inspector

The VideoPlayerInterface component is a favoritable item that is used to specify the UI elements of a custom Video Player.

Fields

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
ItemName IField`1<String> The name of this favoritable item.
SpawningUser UserRef The user that spawned this favoritable item.
SpawningUserID IField`1<String> The field containing the ID of the user that spawned this favoritable item.
IsInstance Bool Whether this item is an instance.
URL IField`1<Uri> The field to fill with the URL of the imported video asset.
Stream IField`1<Bool> The field to fill with whether this video player is showing stream.
VideoClip AssetRef`1<VideoTexture> The field to fill with what the video being displayed is.
VideoClipTexture AssetRef`1<ITexture2D> The field to fill (Usually a material texture field) with the showing video texture.
AspectRatio IField`1<Float> The field to fill with what the video's aspect ratio is.
DefaultVideoClip VideoTexture The default video texture to use if one isn't filled in.
StereoRenderingEnabled IField`1<Bool> The field to fill with whether the video is a stero video (3D)
StereoLayout IField`1<StereoLayout> The field to fill with the kind of stero image layout the image has.
StereoTransformLeft IField`1<Float4> The field to fill with what the rectangle area for the left eye should be.
StereoTransformRight IField`1<Float4> The field to fill with what the rectangle area for the right eye should be.
StereoTransformScaleLeft IField`1<Float2> The field to fill with what the UV scale for the left eye should be.
StereoTransformOffsetLeft IField`1<Float2> The field to fill with what the UV offset for the left eye should be.
StereoTransformScaleRight IField`1<Float2> The field to fill with what the UV scale for the right eye should be.
StereoTransformOffsetRight IField`1<Float2> The field to fill with what the UV offset for the right eye should be.
PanoramicRenderingEnabled IField`1<Bool> The field to fill with whether the video is a 360 video
PanoramicHorizontalFOV IField`1<Float> The field to fill with the video's horizontal 360 video FOV.
PanoramicVerticalFOV IField`1<Float> The field to fill with the video's vertical 360 video FOV.
PanoramicProjection IField`1<PanoramicProjection> The field to fill with what the video's panoramic texture arrangement is.

Usage

Use either the existing Resonite video player under Resonite Essentials or make a UI by attaching the component and making one from scratch. Then save the item with this component to the inventory and favorite it so it becomes the default player upon restarting.

Examples

The default Resonite player that is part of the user's default Favorites

See Also

Retrieved from "https://wiki.resonite.com/index.php?title=Component:VideoPlayerInterface&oldid=95841"