Interface NdiMediaStreamInfo.Builder

All Superinterfaces:
Buildable, CopyableBuilder<NdiMediaStreamInfo.Builder,NdiMediaStreamInfo>, SdkBuilder<NdiMediaStreamInfo.Builder,NdiMediaStreamInfo>, SdkPojo
Enclosing class:
NdiMediaStreamInfo
@Mutable @NotThreadSafe public static interface NdiMediaStreamInfo.Builder extends SdkPojo, CopyableBuilder<NdiMediaStreamInfo.Builder,NdiMediaStreamInfo>

  • Method Details

    • streamType

      NdiMediaStreamInfo.Builder streamType(String streamType)

      The type of media stream (for example, Video or Audio).

      Parameters:
      streamType - The type of media stream (for example, Video or Audio).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • codec

      NdiMediaStreamInfo.Builder codec(String codec)

      The codec used for the media stream. For NDI sources, use speed-hq.

      Parameters:
      codec - The codec used for the media stream. For NDI sources, use speed-hq.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • streamId

      NdiMediaStreamInfo.Builder streamId(Integer streamId)

      A unique identifier for the media stream.

      Parameters:
      streamId - A unique identifier for the media stream.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scanMode

      NdiMediaStreamInfo.Builder scanMode(String scanMode)

      The method used to display video frames. Used when the streamType is Video.

      Parameters:
      scanMode - The method used to display video frames. Used when the streamType is Video.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • scanMode

      NdiMediaStreamInfo.Builder scanMode(ScanMode scanMode)

      The method used to display video frames. Used when the streamType is Video.

      Parameters:
      scanMode - The method used to display video frames. Used when the streamType is Video.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • frameResolution

      NdiMediaStreamInfo.Builder frameResolution(FrameResolution frameResolution)

      The width and height dimensions of the video frame in pixels. Used when the streamType is Video.

      Parameters:
      frameResolution - The width and height dimensions of the video frame in pixels. Used when the streamType is Video.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • frameResolution

      default NdiMediaStreamInfo.Builder frameResolution(Consumer<FrameResolution.Builder> frameResolution)

      The width and height dimensions of the video frame in pixels. Used when the streamType is Video.

      This is a convenience method that creates an instance of the FrameResolution.Builder avoiding the need to create one manually via FrameResolution.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to frameResolution(FrameResolution).

      Parameters:
      frameResolution - a consumer that will call methods on FrameResolution.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • frameRate

      NdiMediaStreamInfo.Builder frameRate(String frameRate)

      The number of video frames displayed per second. Used when the streamType is Video.

      Parameters:
      frameRate - The number of video frames displayed per second. Used when the streamType is Video.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • channels

      NdiMediaStreamInfo.Builder channels(Integer channels)

      The number of audio channels in the stream. Used when the streamType is Audio.

      Parameters:
      channels - The number of audio channels in the stream. Used when the streamType is Audio.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sampleRate

      NdiMediaStreamInfo.Builder sampleRate(Integer sampleRate)

      The number of audio samples captured per second, measured in kilohertz (kHz). Used when the streamType is Audio.

      Parameters:
      sampleRate - The number of audio samples captured per second, measured in kilohertz (kHz). Used when the streamType is Audio.
      Returns:
      Returns a reference to this object so that method calls can be chained together.