Package com.azure.android.communication.calling

Class VideoStreamFormat

  • public final class VideoStreamFormat
extends Object
    Describes details of the video frame content that the application is capable of generating. ACS Calling SDK will dynamically select the VideoStreamFormat best matching with network conditions at runtime.

    • Constructor Summary

      Constructors 
      Constructor Description
      VideoStreamFormat()
      Default constructor

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void finalize()
      Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
      float getFramesPerSecond()
      Informs how many frames per second the virtual video device will be sending to remote participants.
      int getHeight()
      Total height-wise count of pixels of the video frame.
      VideoStreamPixelFormat getPixelFormat()
      Informs how the content of the video frame is encoded.
      VideoStreamResolution getResolution()
      Width and height to be used from a known video resolution standard
      int getStride1()
      Informs the stride in bytes for the first plane of the video frame content when RawVideoFrameType is VideoSoftware.
      int getStride2()
      For VideoFormats with more than one plane, informs the stride in bytes for the second plane of the video frame content when RawVideoFrameType is VideoSoftware.
      int getStride3()
      For VideoFormats with more than two planes, informs the stride in bytes for the third plane of the video frame content when RawVideoFrameType is VideoSoftware.
      int getWidth()
      Total width-wise count of pixels of the video frame.
      VideoStreamFormat setFramesPerSecond​(float value)
      Informs how many frames per second the virtual video device will be sending to remote participants.
      VideoStreamFormat setHeight​(int value)
      Total height-wise count of pixels of the video frame.
      VideoStreamFormat setPixelFormat​(VideoStreamPixelFormat value)
      Informs how the content of the video frame is encoded.
      VideoStreamFormat setResolution​(VideoStreamResolution value)
      Width and height to be used from a known video resolution standard
      VideoStreamFormat setStride1​(int value)
      Informs the stride in bytes for the first plane of the video frame content when RawVideoFrameType is VideoSoftware.
      VideoStreamFormat setStride2​(int value)
      For VideoFormats with more than one plane, informs the stride in bytes for the second plane of the video frame content when RawVideoFrameType is VideoSoftware.
      VideoStreamFormat setStride3​(int value)
      For VideoFormats with more than two planes, informs the stride in bytes for the third plane of the video frame content when RawVideoFrameType is VideoSoftware.
      VideoStreamFormat setWidth​(int value)
      Total width-wise count of pixels of the video frame.

      • Methods inherited from class Object

        clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • VideoStreamFormat

        public VideoStreamFormat()
        Default constructor

    • Method Detail

      • finalize

        protected void finalize()
        Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
        Overrides:
        finalize in class Object

      • getWidth

        public int getWidth()
        Total width-wise count of pixels of the video frame. It must be greater or equal to 240 and less or equal to 1920. Values greater than 1280 and aspect ratios other than 16:9 or 4:3 might be adjusted by the SDK consuming extra resources.

      • setWidth

        public VideoStreamFormat setWidth​(int value)
        Total width-wise count of pixels of the video frame. It must be greater or equal to 240 and less or equal to 1920. Values greater than 1280 and aspect ratios other than 16:9 or 4:3 might be adjusted by the SDK consuming extra resources.
        Parameters:
        value - The new value.

      • getHeight

        public int getHeight()
        Total height-wise count of pixels of the video frame. It must be greater or equal to 180 and less or equal to 1080. Values greater than 720 and aspect ratios other than 16:9 or 4:3 might be adjusted by the SDK consuming extra resources.

      • setHeight

        public VideoStreamFormat setHeight​(int value)
        Total height-wise count of pixels of the video frame. It must be greater or equal to 180 and less or equal to 1080. Values greater than 720 and aspect ratios other than 16:9 or 4:3 might be adjusted by the SDK consuming extra resources.
        Parameters:
        value - The new value.

      • getResolution

        public VideoStreamResolution getResolution()
        Width and height to be used from a known video resolution standard

      • setResolution

        public VideoStreamFormat setResolution​(VideoStreamResolution value)
        Width and height to be used from a known video resolution standard
        Parameters:
        value - The new value.

      • getPixelFormat

        public VideoStreamPixelFormat getPixelFormat()
        Informs how the content of the video frame is encoded.

      • getFramesPerSecond

        public float getFramesPerSecond()
        Informs how many frames per second the virtual video device will be sending to remote participants. It must be greater or equal to 1 and lower or equal to 30. The following values are preferable 7.5, 15 or 30.

      • setFramesPerSecond

        public VideoStreamFormat setFramesPerSecond​(float value)
        Informs how many frames per second the virtual video device will be sending to remote participants. It must be greater or equal to 1 and lower or equal to 30. The following values are preferable 7.5, 15 or 30.
        Parameters:
        value - The new value.

      • getStride1

        public int getStride1()
        Informs the stride in bytes for the first plane of the video frame content when RawVideoFrameType is VideoSoftware. It must be greater or equal to the count of bytes required for the first plane of the selected VideoStreamPixelFormat.

      • setStride1

        public VideoStreamFormat setStride1​(int value)
        Informs the stride in bytes for the first plane of the video frame content when RawVideoFrameType is VideoSoftware. It must be greater or equal to the count of bytes required for the first plane of the selected VideoStreamPixelFormat.
        Parameters:
        value - The new value.

      • getStride2

        public int getStride2()
        For VideoFormats with more than one plane, informs the stride in bytes for the second plane of the video frame content when RawVideoFrameType is VideoSoftware. It must be greater or equal to the count of bytes required for the second plane of the selected VideoStreamPixelFormat.

      • setStride2

        public VideoStreamFormat setStride2​(int value)
        For VideoFormats with more than one plane, informs the stride in bytes for the second plane of the video frame content when RawVideoFrameType is VideoSoftware. It must be greater or equal to the count of bytes required for the second plane of the selected VideoStreamPixelFormat.
        Parameters:
        value - The new value.

      • getStride3

        public int getStride3()
        For VideoFormats with more than two planes, informs the stride in bytes for the third plane of the video frame content when RawVideoFrameType is VideoSoftware. It must be greater or equal to the count of bytes required for the third plane of the selected VideoStreamPixelFormat.

      • setStride3

        public VideoStreamFormat setStride3​(int value)
        For VideoFormats with more than two planes, informs the stride in bytes for the third plane of the video frame content when RawVideoFrameType is VideoSoftware. It must be greater or equal to the count of bytes required for the third plane of the selected VideoStreamPixelFormat.
        Parameters:
        value - The new value.