Package com.oracle.media.model.api.common

Interface StreamMetadata

public interface StreamMetadata
Represents metadata associated with a media stream, including a description and custom key-value pairs.

Implementations of this interface provide access to the stream metadata, which can be used to store additional information about the media stream.

To create a new instance of StreamMetadata, use the Builder pattern: StreamMetadata metadata = new StreamMetadataImpl.Builder() .description("Media stream metadata") .streamDirection("outgoing") .addCustom("key1", "value1") .addCustom("key2", 123) .build();

Author:
Copyright (c) 2025 by Oracle, Inc. All Rights Reserved.

  • Method Details

    • getDescription

      String getDescription()
      Gets the description of the media stream.
      Returns:
      the description, or null if not applicable.

    • setDescription

      void setDescription(String description)
      Sets the description of the media stream.
      Parameters:
      description - the description to set.

    • getCustom

      Map<String,Object> getCustom()
      Gets the custom metadata associated with the media stream.
      Returns:
      the custom metadata, or null if not applicable.

    • setCustom

      void setCustom(Map<String,Object> custom)
      Sets the custom metadata associated with the media stream.
      Parameters:
      custom - the custom metadata to set.

    • getStreamDirection

      String getStreamDirection()
      Gets the stream direction associated with the media stream.
      Returns:
      the stream direction as a String, or null if not applicable.

    • setStreamDirection

      void setStreamDirection(String streamDirection)
      Sets the stream direction associated with the media stream.
      Parameters:
      streamDirection - the stream direction to set.