Global

Members

(constant) capabilities

Representation of a capability, a concept to be developed in future versions.
Source:

(readonly) deviceTypes :string

Types of device.
Type:
  • string
Properties:
Name Type Description
pipeline string Value urn:x-ipstudio:device:pipeline.
generic string Value urn:x-ipstudio:device:generic.
Source:

(readonly) formats :string

A URN describing the data format of a video, audio or event [flow]{@link Flow

Sub-classifications of these core URNs may also be encountered within this API version (such as urn:x-ipstudio:format:video.raw), and should still be interpreted correctly by consumers up to the boundaries above.

Type:
  • string
Properties:
Name Type Description
video string Value urn:x-ipstudio:format:video.
audio string Value urn:x-ipstudio:format:audio.
event string Value urn:x-ipstudio:format:event.
Source:

(readonly) transports :string

A URN describing the protocol used to send data (video, audio, events etc.) over a network.

For example, an RTP Transmitter sending to a multicast group should use the transport 'urn:x-ipstudio:transport:rtp.mcast', but a receiver supporting both unicast and multicast should present the transport 'urn:x-ipstudio:transport:rtp' to indicate its less restrictive state.

Type:
  • string
Properties:
Name Type Description
rtp string Value urn:x-ipstudio:transport:rtp.
rtp_ucast string Value urn:x-ipstudio:transport:rtp.ucast.
rtp_mcast string Value urn:x-ipstudio:transport:rtp.mcast.
dash string Value urn:x-ipstudio:transport:dash.
Source:

Methods

statusError(status, message) → {Error}

Add a status code to an error object.
Parameters:
Name Type Description
status Number Status code for the error.
message string Error message describing the error.
Source:
Returns:
The newly created error with status set.
Type
Error