Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AudioMedia

Hierarchy

Index

Properties

dir

dir: string

Returns the direction of the media from our perspective. The value is one of: 'none', 'inbound', 'outbound', 'bidirectional', or 'unknown'.

rtcpAddr

rtcpAddr: string

Returns the remote address (and port) of where the RTCP originates.

rtpAddr

rtpAddr: string

Returns the remote address (and port) of where the RTP originates.

rxLevel

rxLevel: number

Returns the last received signal level.

txLevel

txLevel: number

Returns the last transmitted signal level.

Methods

adjustRxLevel

  • adjustRxLevel(val: number): void
  • Adjust the signal level of the audio sent to this Media by making it louder or quieter: a val of 1.0 means no level adjustment and a val of 0 means to mute.

    Parameters

    • val: number

    Returns void

adjustTxLevel

  • adjustTxLevel(val: number): void
  • Adjust the signal level of the audio sent from this Media by making it louder or quieter: a val of 1.0 means no level adjustment and a val of 0 means to mute.

    Parameters

    • val: number

    Returns void

close

  • close(): void
  • Immediately closes the Media. This can be useful to do explicitly since v8's garbage collector is quite lazy. After calling this, using this particular Media instance (and its methods) is useless.

    Returns void

startTransmitTo

  • startTransmitTo(sink: Media): void
  • Starts transmitting to sink.

    fires

    AudioMedia#eof

    Parameters

    Returns void

stopTransmitTo

  • stopTransmitTo(sink: Media): void

Generated using TypeDoc