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

Interface IngressMediaStream

public interface IngressMediaStream
Represents an ingress media stream, encapsulating its identifiers, ingress source type, offered SDP, negotiated SDP, and metadata.

Implementations of this interface provide access to the ingress media stream's properties, which are used to configure and manage the stream.

Notes:

  • The value of ingressSourceType must be an instance of the IngressSourceType enumeration.
  • In a CreateMediaRequest, the offeredSDP contains a Connection object (set with mediaSourceIp and mediaSourcePort), and the negotiatedSDP does not include a Connection object.
  • In a CreateMediaResponse, the negotiatedSDP contains a Connection object (set with mediaReceiverIp and mediaReceiverPort), while the offeredSDP does not include a Connection object.

Example usage: 


 IngressMediaStream ingressMediaStream = new IngressMediaStreamImpl.Builder()
     .identifiers(identifiers)
     .ingressSourceType(IngressSourceType.RTP) // can be any value from the enuy
     .offeredSDP(offeredSdp)        // request: includes Connection; response: null or no Connection set
     .negotiatedSDP(negotiatedSdp)  // request: null or no Connection set; response: includes Connection
     .metadata(streamMetadata)
     .build();

Construct the OfferedSDP or NegotiatedSDP accordingly for your application context.

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

  • Method Details

    • getIdentifiers

      Identifiers getIdentifiers()
      Gets the identifiers associated with the ingress media stream.
      Returns:
      the identifiers.

    • setIdentifiers

      void setIdentifiers(Identifiers identifiers)
      Sets the identifiers associated with the ingress media stream.
      Parameters:
      identifiers - the identifiers to set.

    • getIngressSourceType

      IngressSourceType getIngressSourceType()
      Gets the type of ingress stream.
      Returns:
      the ingress source type.

    • setIngressSourceType

      void setIngressSourceType(IngressSourceType ingressSourceType)
      Sets the type of ingress stream.
      Parameters:
      ingressSourceType - the ingress source type to set.

    • getOfferedSDP

      OfferedSDP getOfferedSDP()
      Gets the offered SDP for the ingress media stream.
      Returns:
      the offered SDP.

    • setOfferedSDP

      void setOfferedSDP(OfferedSDP offeredSDP)
      Sets the offered SDP for the ingress media stream.
      Parameters:
      offeredSDP - the offered SDP to set.

    • getNegotiatedSDP

      NegotiatedSDP getNegotiatedSDP()
      Gets the negotiated SDP for the ingress media stream.
      Returns:
      the negotiated SDP, or null if not applicable.

    • setNegotiatedSDP

      void setNegotiatedSDP(NegotiatedSDP negotiatedSDP)
      Sets the negotiated SDP for the ingress media stream.
      Parameters:
      negotiatedSDP - the negotiated SDP to set.

    • getMetadata

      StreamMetadata getMetadata()
      Gets the metadata associated with the ingress media stream.
      Returns:
      the metadata.

    • setMetadata

      void setMetadata(StreamMetadata metadata)
      Sets the metadata associated with the ingress media stream.
      Parameters:
      metadata - the metadata to set.