Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ReceiveOnlyAttribute

This specifies that the tools should be started in receive-only mode where applicable. It can be either a session- or media- level attribute, and it is not dependent on charset. Note that recvonly applies to the media only, not to any associated control protocol (e.g., an RTP-based system in recvonly mode SHOULD still send RTCP packets).

Hierarchy

  • DirectionAttribute
    • ReceiveOnlyAttribute

Index

Constructors

Methods

Constructors

constructor

  • Initializes a new instance of the fm.icelink.sdp.receiveOnlyAttribute class.

    Returns ReceiveOnlyAttribute

Methods

getAttributeType

  • getAttributeType(): AttributeType
  • Gets this Attribute's Type.

    Returns AttributeType

Protected getAttributeValue

  • getAttributeValue(): string
  • Gets the internal value of the attribute.

    Returns string

getStreamDirection

  • getStreamDirection(): StreamDirection
  • Gets the stream direction.

    Returns StreamDirection

getTypeString

  • getTypeString(): string

  • Returns string

setAttributeType

  • setAttributeType(value: AttributeType): void
  • Sets this Attribute's Type.

    Parameters

    • value: AttributeType

    Returns void

toString

  • toString(): string
  • Converts this instance to a string.

    Returns string

Static createAttribute

  • createAttribute(name: string, value: string): Attribute
  • Creates an attribute.

    Parameters

    • name: string

      The name.

    • value: string

      The value.

    Returns Attribute

Static fromAttributeValue

  • fromAttributeValue(value: string): ReceiveOnlyAttribute
  • Initializes a new instance of the fm.icelink.sdp.receiveOnlyAttribute class.

    Parameters

    • value: string

      The attribute value.

    Returns ReceiveOnlyAttribute

Static generateDirectionAttribute

  • generateDirectionAttribute(direction: StreamDirection): DirectionAttribute
  • Creates a DirectionAttribute for a required direction.

    Parameters

    • direction: StreamDirection

      Direction.

    Returns DirectionAttribute

Static getTypeName

  • getTypeName(type: Type): string
  • Gets the name of the attribute type.

    Parameters

    • type: Type

      The attribute type.

    Returns string

Static isMediaLevel

  • isMediaLevel(type: Type): boolean
  • Determines whether the type applies to media streams.

    Parameters

    • type: Type

      The type.

    Returns boolean

Static isSessionLevel

  • isSessionLevel(type: Type): boolean
  • Determines whether the type applies to sessions.

    Parameters

    • type: Type

      The type.

    Returns boolean

Static parse

  • parse(s: string): Attribute
  • Creates an fm.icelink.sdp.connectionData instance from a string.

    Parameters

    • s: string

      The string to parse.

    Returns Attribute