docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class VideoStreamReceiver

    Component for receiving video streams.

    Inheritance
    object
    Object
    Component
    Behaviour
    MonoBehaviour
    StreamReceiverBase
    VideoStreamReceiver
    Implements
    IStreamReceiver
    Inherited Members
    StreamReceiverBase.Transceiver
    StreamReceiverBase.OnStartedStream
    StreamReceiverBase.OnStoppedStream
    StreamReceiverBase.Track
    StreamReceiverBase.isPlaying
    StreamReceiverBase.SetTransceiver(string, RTCRtpTransceiver)
    StreamReceiverBase.OnDestroy()
    MonoBehaviour.IsInvoking()
    MonoBehaviour.CancelInvoke()
    MonoBehaviour.Invoke(string, float)
    MonoBehaviour.InvokeRepeating(string, float, float)
    MonoBehaviour.CancelInvoke(string)
    MonoBehaviour.IsInvoking(string)
    MonoBehaviour.StartCoroutine(string)
    MonoBehaviour.StartCoroutine(string, object)
    MonoBehaviour.StartCoroutine(IEnumerator)
    MonoBehaviour.StopCoroutine(IEnumerator)
    MonoBehaviour.StopCoroutine(Coroutine)
    MonoBehaviour.StopCoroutine(string)
    MonoBehaviour.StopAllCoroutines()
    MonoBehaviour.print(object)
    MonoBehaviour.useGUILayout
    MonoBehaviour.runInEditMode
    Behaviour.enabled
    Behaviour.isActiveAndEnabled
    Component.GetComponent(Type)
    Component.GetComponent<T>()
    Component.TryGetComponent(Type, out Component)
    Component.TryGetComponent<T>(out T)
    Component.GetComponent(string)
    Component.GetComponentInChildren(Type, bool)
    Component.GetComponentInChildren(Type)
    Component.GetComponentInChildren<T>(bool)
    Component.GetComponentInChildren<T>()
    Component.GetComponentsInChildren(Type, bool)
    Component.GetComponentsInChildren(Type)
    Component.GetComponentsInChildren<T>(bool)
    Component.GetComponentsInChildren<T>(bool, List<T>)
    Component.GetComponentsInChildren<T>()
    Component.GetComponentsInChildren<T>(List<T>)
    Component.GetComponentInParent(Type, bool)
    Component.GetComponentInParent(Type)
    Component.GetComponentInParent<T>(bool)
    Component.GetComponentInParent<T>()
    Component.GetComponentsInParent(Type, bool)
    Component.GetComponentsInParent(Type)
    Component.GetComponentsInParent<T>(bool)
    Component.GetComponentsInParent<T>(bool, List<T>)
    Component.GetComponentsInParent<T>()
    Component.GetComponents(Type)
    Component.GetComponents(Type, List<Component>)
    Component.GetComponents<T>(List<T>)
    Component.GetComponents<T>()
    Component.CompareTag(string)
    Component.SendMessageUpwards(string, object, SendMessageOptions)
    Component.SendMessageUpwards(string, object)
    Component.SendMessageUpwards(string)
    Component.SendMessageUpwards(string, SendMessageOptions)
    Component.SendMessage(string, object)
    Component.SendMessage(string)
    Component.SendMessage(string, object, SendMessageOptions)
    Component.SendMessage(string, SendMessageOptions)
    Component.BroadcastMessage(string, object, SendMessageOptions)
    Component.BroadcastMessage(string, object)
    Component.BroadcastMessage(string)
    Component.BroadcastMessage(string, SendMessageOptions)
    Component.transform
    Component.gameObject
    Component.tag
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(object)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, bool)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, bool)
    Object.Destroy(Object, float)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, bool)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, bool)
    Object.FindObjectsByType(Type, FindObjectsSortMode)
    Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)
    Object.DontDestroyOnLoad(Object)
    Object.FindObjectsOfType<T>()
    Object.FindObjectsByType<T>(FindObjectsSortMode)
    Object.FindObjectsOfType<T>(bool)
    Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
    Object.FindObjectOfType<T>()
    Object.FindObjectOfType<T>(bool)
    Object.FindFirstObjectByType<T>()
    Object.FindAnyObjectByType<T>()
    Object.FindFirstObjectByType<T>(FindObjectsInactive)
    Object.FindAnyObjectByType<T>(FindObjectsInactive)
    Object.FindObjectOfType(Type)
    Object.FindFirstObjectByType(Type)
    Object.FindAnyObjectByType(Type)
    Object.FindObjectOfType(Type, bool)
    Object.FindFirstObjectByType(Type, FindObjectsInactive)
    Object.FindAnyObjectByType(Type, FindObjectsInactive)
    Object.ToString()
    Object.name
    Object.hideFlags
    Namespace: Unity.RenderStreaming
    Assembly: Unity.RenderStreaming.dll
    Syntax
    [AddComponentMenu("Render Streaming/Video Stream Receiver")]
    public class VideoStreamReceiver : StreamReceiverBase, IStreamReceiver

    Fields

    OnUpdateReceiveTexture

    Event triggered when the received texture is updated.

    Declaration
    public VideoStreamReceiver.OnUpdateReceiveTextureHandler OnUpdateReceiveTexture
    Field Value
    Type Description
    VideoStreamReceiver.OnUpdateReceiveTextureHandler

    Properties

    codec

    Gets the codec information for the video stream.

    Declaration
    public VideoCodecInfo codec { get; }
    Property Value
    Type Description
    VideoCodecInfo

    height

    The height of the received video stream.

    Declaration
    public int height { get; }
    Property Value
    Type Description
    int

    targetTexture

    The target RenderTexture.

    Declaration
    public RenderTexture targetTexture { get; set; }
    Property Value
    Type Description
    RenderTexture

    texture

    The texture of the received video stream.

    Declaration
    public Texture texture { get; }
    Property Value
    Type Description
    Texture

    width

    The width of the received video stream.

    Declaration
    public int width { get; }
    Property Value
    Type Description
    int

    Methods

    GetAvailableCodecs()

    Declaration
    public static IEnumerable<VideoCodecInfo> GetAvailableCodecs()
    Returns
    Type Description
    IEnumerable<VideoCodecInfo>

    SetCodec(VideoCodecInfo)

    Sets the codec for the video stream.

    Declaration
    public void SetCodec(VideoCodecInfo codec)
    Parameters
    Type Name Description
    VideoCodecInfo codec

    The codec information to set.

    Examples
    var codec = VideoStreamReceiver.GetAvailableCodecs().FirstOrDefault(x => x.mimeType.Contains("VP9"));
    videoStreamReceiver.SetCodec(codec);
    Exceptions
    Type Condition
    InvalidOperationException

    Thrown if the transceiver is streaming or the track has ended.

    Implements

    IStreamReceiver
    In This Article
    Back to top
    Copyright © 2024 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)