Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OrientationAttribute

Normally this is only used for a whiteboard or presentation tool. It specifies the orientation of a the workspace on the screen. It is a media-level attribute. Permitted values are "portrait", "landscape", and "seascape" (upside-down landscape). It is not dependent on charset.

Hierarchy

  • Attribute
    • OrientationAttribute

Index

Constructors

Properties

Methods

Constructors

constructor

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

    Parameters

    • orientation: string

      The orientation of a workspace on the screen. See fm.icelink.sdp.orientationAttribute.orientation for possible values.

    Returns OrientationAttribute

Properties

Private _orientation

_orientation: string
internal

Methods

getAttributeType

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

    Returns AttributeType

Protected getAttributeValue

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

    Returns string

getOrientation

  • getOrientation(): string
  • Gets the orientation of a workspace on the screen. See fm.icelink.sdp.orientationAttribute.orientation for possible values.

    Returns string

getTypeString

  • getTypeString(): string

  • Returns string

setAttributeType

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

    Parameters

    • value: AttributeType

    Returns void

Private setOrientation

  • setOrientation(value: string): void
  • internal

    Parameters

    • value: string

    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): OrientationAttribute
  • Initializes a new instance of the fm.icelink.sdp.orientationAttribute class.

    Parameters

    • value: string

      The attribute value.

    Returns OrientationAttribute

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