Class SourceIdentifier

Represents a source identifier. This class allows to parse the identifier of the source into components like the publisher name, type of the source and name of the source.

Index

Constructors

Accessors

publisherName sourceId sourceName sourceType

Methods

Constructors

constructor

new SourceIdentifier(
    publisherName: string,
    sourceType: SourceType,
    sourceName: string,
): SourceIdentifier
Create an instance of the SourceIdentifier class.
Parameters
- publisherName: string
  Name of the source publisher.
- sourceType: SourceType
  Type of source.
- sourceName: string
  Name of the source.
Returns SourceIdentifier
- Defined in sourceIdentifier.ts:42

Accessors

publisherName

get publisherName(): string
Gets the name of the publisher.

Returns string
- Defined in sourceIdentifier.ts:17

sourceId

get sourceId(): string
Gets the source identifier.

Returns string
- Defined in sourceIdentifier.ts:10

sourceName

get sourceName(): string
Gets the name of the source.

Returns string
- Defined in sourceIdentifier.ts:31

sourceType

get sourceType(): SourceType
Gets the type of source published.

Returns SourceType
- Defined in sourceIdentifier.ts:24

Methods

`Static`fromSourceId

fromSourceId(sourceId: string): SourceIdentifier
Get a SourceIdentifier object extracted from the source ID received from the Dolby Millicast platform.
Parameters
- sourceId: string
  Source Identifier received from the Dolby Millicast platform.
Returns SourceIdentifier
The SourceIdentifier object representing the source identifier.
- Defined in sourceIdentifier.ts:63