@millicast/sdk-interactivity/dist/src/sourceIdentifier.d.ts

Dolby Millicast Interactivity SDK

import { SourceType } from './types/sourceType';
/**
 * 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.
 */
export declare class SourceIdentifier {
    #private;
    /** Gets the source identifier. */
    get sourceId(): string;
    /** Gets the name of the publisher. */
    get publisherName(): string;
    /** Gets the type of source published. */
    get sourceType(): SourceType;
    /** Gets the name of the source. */
    get sourceName(): string;
    /**
     * Create an instance of the {@link SourceIdentifier} class.
     *
     * @param publisherName Name of the source publisher.
     * @param sourceType Type of source.
     * @param sourceName Name of the source.
     */
    constructor(publisherName: string, sourceType: SourceType, sourceName: string);
    /**
     * Get a {@link SourceIdentifier} object extracted from the source ID received from the Dolby Millicast platform.
     *
     * @param sourceId Source Identifier received from the Dolby Millicast platform.
     *
     * @returns The {@link SourceIdentifier} object representing the source identifier.
     */
    static fromSourceId: (sourceId: string) => SourceIdentifier;
}
//# sourceMappingURL=sourceIdentifier.d.ts.map