@livo-tv/sdk 1.0.0 → 1.1.0

package/dist/studio/index.d.ts

@@ -0,0 +1,496 @@
+import * as react from 'react';
+import { ReactNode } from 'react';
+export { a as applyEmbedTheme, d as decodeEmbedTheme } from '../theme-CjyIlZUs.js';
+
+type StudioRole = "moderator" | "guest";
+type StudioStageStatus = "OFF_STAGE" | "REQUESTED_TO_JOIN_STAGE" | "ACCEPTED_TO_JOIN_STAGE" | "ON_STAGE";
+type StudioStreamSummary = {
+    id: string;
+    title: string;
+    status: string;
+    encoderLostAt?: number | null;
+};
+type StudioSession = {
+    authToken: string;
+    meetingId: string;
+    role: StudioRole;
+    guestUrl: string | null;
+    studioControlToken?: string | null;
+    expiresAt?: number | null;
+    stream: StudioStreamSummary;
+};
+type StudioWaitlistedGuest = {
+    id: string;
+    name: string;
+    userId?: string;
+    picture?: string | null;
+};
+type StudioStageRequest = {
+    userId: string;
+    peerId: string;
+    name: string;
+};
+type StudioParticipantTile = {
+    id: string;
+    name: string;
+    isSelf: boolean;
+    audioEnabled: boolean;
+    videoEnabled: boolean;
+    screenShareEnabled: boolean;
+    picture: string | null;
+    userId?: string;
+    stageStatus?: StudioStageStatus;
+    pinned?: boolean;
+    chatCanSend?: boolean;
+};
+type StudioChatMessage = {
+    id: string;
+    userId: string;
+    name: string;
+    text: string;
+    time: number;
+    targetUserIds?: string[];
+    pinned?: boolean;
+    isEdited?: boolean;
+};
+
+type StudioLivestreamEgress = "live" | "starting";
+declare function studioErrorCode(error: unknown): string | null;
+
+/** Injected by the host app. JWT mint stays outside the SDK. */
+type StudioControlActions = {
+    livestream: () => Promise<StudioLivestreamEgress>;
+    publish: () => Promise<void>;
+    stop: () => Promise<void>;
+};
+
+type StudioControlClientOptions = {
+    apiUrl?: string;
+    token: string;
+    fetchFn?: typeof fetch;
+};
+declare class StudioControlError extends Error {
+    readonly status: number;
+    readonly body: unknown;
+    constructor(status: number, message: string, body: unknown);
+}
+declare class StudioControlClient {
+    private token;
+    private readonly apiUrl;
+    private readonly fetchFn;
+    constructor(options: StudioControlClientOptions);
+    get currentToken(): string;
+    private url;
+    private request;
+    livestream(): Promise<{
+        ok: true;
+        egress: "live" | "starting";
+    }>;
+    publish(): Promise<{
+        stream: {
+            id: string;
+            status: string;
+        };
+    }>;
+    stop(): Promise<{
+        stream: {
+            id: string;
+            status: string;
+        };
+    }>;
+    state(): Promise<{
+        stream: {
+            id: string;
+            title: string;
+            status: string;
+        };
+    }>;
+    refresh(): Promise<{
+        studioControlToken: string;
+        expiresAt: number;
+    }>;
+}
+declare function createStudioControlClient(options: StudioControlClientOptions): StudioControlClient;
+declare function controlActionsFromClient(client: StudioControlClient): StudioControlActions;
+
+type StudioDeviceKind = "audio" | "video" | "speaker";
+type StudioDeviceOption = {
+    deviceId: string;
+    label: string;
+};
+type StudioDevices = {
+    audio: StudioDeviceOption[];
+    video: StudioDeviceOption[];
+    speaker: StudioDeviceOption[];
+};
+type StudioVideoKind = "camera" | "screen";
+type StudioHostMediaKind = "audio" | "video" | "screen";
+type StudioScreenSharePermission = "ALLOWED" | "NOT_ALLOWED" | "CAN_REQUEST";
+type StudioBroadcast = {
+    type: "host-media";
+    kind: StudioHostMediaKind;
+} | {
+    type: "share-request";
+    participantId: string;
+    name: string;
+} | {
+    type: "share-response";
+    participantId: string;
+    granted: boolean;
+} | {
+    type: "display-name";
+    participantId: string;
+    name: string;
+};
+type StudioBroadcastTarget = {
+    participantIds: string[];
+} | {
+    presetNames: string[];
+};
+type StudioMeetingHandle = {
+    join: () => Promise<void>;
+    leave: () => Promise<void>;
+    setAudioEnabled: (enabled: boolean) => Promise<void>;
+    setVideoEnabled: (enabled: boolean) => Promise<void>;
+    setScreenShareEnabled: (enabled: boolean) => Promise<void>;
+    admit: (participantId: string) => Promise<void>;
+    deny: (participantId: string) => Promise<void>;
+    kick: (participantId: string) => Promise<void>;
+    disableParticipantMedia: (participantId: string, kind: StudioHostMediaKind) => Promise<void>;
+    sendBroadcast: (message: StudioBroadcast, target?: StudioBroadcastTarget) => Promise<void>;
+    subscribeBroadcast: (cb: (message: StudioBroadcast) => void) => () => void;
+    admitAs: (participantId: string, as: "panelist" | "audience") => Promise<void>;
+    admitAll: (as: "panelist" | "audience") => Promise<void>;
+    setStageAccess: (userId: string, on: boolean) => Promise<void>;
+    denyStageAccess: (userId: string) => Promise<void>;
+    requestStageAccess: () => Promise<void>;
+    leaveStage: () => Promise<void>;
+    stageStatus: () => StudioStageStatus;
+    stageRequests: () => StudioStageRequest[];
+    subscribeStage: (cb: () => void) => () => void;
+    canManageStage: () => boolean;
+    stageEnabled: () => boolean;
+    ensureStageJoined: () => Promise<void>;
+    setParticipantPinned: (participantId: string, pinned: boolean) => Promise<void>;
+    pinnedIds: () => string[];
+    subscribePinned: (cb: () => void) => () => void;
+    setParticipantChat: (participantId: string, enabled: boolean) => Promise<void>;
+    sendChatMessage: (text: string, participantIds?: string[]) => Promise<void>;
+    editChatMessage: (id: string, text: string) => Promise<void>;
+    deleteChatMessage: (id: string) => Promise<void>;
+    pinChatMessage: (id: string, pinned: boolean) => Promise<void>;
+    fetchChatHistory: (opts?: {
+        timestamp?: number;
+        userId?: string;
+    }) => Promise<StudioChatMessage[]>;
+    pinnedChatMessages: () => StudioChatMessage[];
+    chatMaxTextLimit: () => number;
+    subscribeParticipants: (cb: () => void) => () => void;
+    participants: () => StudioParticipantTile[];
+    waitlisted: () => StudioWaitlistedGuest[];
+    inWaitingRoom: () => boolean;
+    moderatorIds: () => string[];
+    localAudioTrack: () => MediaStreamTrack | null;
+    localVideoTrack: () => MediaStreamTrack | null;
+    participantVideoTrack: (participantId: string) => MediaStreamTrack | null;
+    participantScreenTrack: (participantId: string) => MediaStreamTrack | null;
+    activeSpeakerId: () => string | null;
+    subscribeActiveSpeaker: (cb: () => void) => () => void;
+    screenSharePermission: () => StudioScreenSharePermission;
+    subscribePermissions: (cb: () => void) => () => void;
+    attachVideo: (participantId: string, el: HTMLVideoElement | null, kind?: StudioVideoKind) => void;
+    attachAudio: (participantId: string, el: HTMLAudioElement | null) => void;
+    subscribeMedia: (cb: () => void) => () => void;
+    subscribeRoomLeft: (cb: (state: string) => void) => () => void;
+    chatMessages: () => StudioChatMessage[];
+    subscribeChat: (cb: () => void) => () => void;
+    listDevices: () => Promise<StudioDevices>;
+    setDevice: (kind: StudioDeviceKind, deviceId: string) => Promise<void>;
+    setDisplayName: (name: string) => Promise<void>;
+    livestreamState: () => string | null;
+    roomState: () => string | null;
+    startLivestream: () => Promise<void>;
+};
+
+type StudioRoomLabels = ReturnType<typeof studioRoomLabels>;
+declare function studioRoomLabels(t: (key: string, values?: Record<string, string>) => string): {
+    live: string;
+    preview: string;
+    waiting: string;
+    waitingHost: string;
+    admit: string;
+    deny: string;
+    denied: string;
+    denyError: string;
+    rejectedTitle: string;
+    rejectedDescription: string;
+    rejectedAction: string;
+    kick: string;
+    camera: string;
+    screen: string;
+    mute: string;
+    unmute: string;
+    copyLink: string;
+    shareLink: string;
+    shareGuestText: string;
+    shareFailed: string;
+    copied: string;
+    publish: string;
+    publishTitle: string;
+    publishDescription: string;
+    publishConfirm: string;
+    publishPending: string;
+    stop: string;
+    stopTitle: string;
+    stopDescription: string;
+    stopConfirm: string;
+    fullscreen: string;
+    publishError: string;
+    stopError: string;
+    published: string;
+    stopped: string;
+    cameraDevice: string;
+    micDevice: string;
+    speakerDevice: string;
+    preflightCamera: string;
+    preflightMic: string;
+    knock: string;
+    egressLost: string;
+    livestreamStarting: string;
+    livestreamSending: string;
+    livestreamInitializing: string;
+    livestreamRetry: string;
+    livestreamError: string;
+    screenBusy: string;
+    endedTitle: string;
+    endedDescription: string;
+    endedAction: string;
+    rejoin: string;
+    duplicateTitle: string;
+    duplicateDescription: string;
+    duplicateDescriptionNoTakeover: string;
+    duplicateAction: string;
+    duplicateTakenOver: string;
+    joinBusy: string;
+    cameraError: string;
+    screenError: string;
+    leave: string;
+    leaveTitle: string;
+    leaveDescription: string;
+    leaveConfirm: string;
+    chat: string;
+    chatSend: string;
+    chatPlaceholder: string;
+    chatError: string;
+    settings: string;
+    settingsTitle: string;
+    settingsDescription: string;
+    guestName: string;
+    displayNameSave: string;
+    displayNameSaved: string;
+    displayNameError: string;
+    testSpeaker: string;
+    testSpeakerError: string;
+    cameraOff: string;
+    micLevel: string;
+    share: string;
+    shareCopied: string;
+    stopCamera: string;
+    stopScreen: string;
+    hostMutedYou: string;
+    hostStoppedYourCamera: string;
+    hostStoppedYourScreen: string;
+    hostMediaError: string;
+    tileMenu: string;
+    openPip: string;
+    closePip: string;
+    backToStudio: string;
+    pipTitle: string;
+    pipError: string;
+    screenUnsupportedDevice: string;
+    screenNotAllowed: string;
+    askToShare: string;
+    shareRequested: string;
+    cancelShareRequest: string;
+    shareRequestSent: string;
+    shareRequestFrom: string;
+    approve: string;
+    shareApproved: string;
+    shareDenied: string;
+    shareRequestError: string;
+    shareRequestTimeout: string;
+    shareRespondError: string;
+    goOffAir: string;
+    goOnAir: string;
+    takeOffAir: string;
+    bringOnAir: string;
+    offAir: string;
+    offAirCount: string;
+    offAirBanner: string;
+    offAirLastVisible: string;
+    offAirHidden: string;
+    offAirShown: string;
+    offAirError: string;
+    takeOffAirTitle: string;
+    takeOffAirDescription: string;
+    takeOffAirConfirm: string;
+    admitAsPanelist: string;
+    admitAsAudience: string;
+    admitAllPanelists: string;
+    admitAllAudience: string;
+    askToGoOnAir: string;
+    stageRequested: string;
+    stageRequests: string;
+    people: string;
+    panelists: string;
+    audience: string;
+    noWaiting: string;
+    noPanelists: string;
+    noAudience: string;
+    closePanel: string;
+    muteChat: string;
+    allowChat: string;
+    pin: string;
+    unpin: string;
+    pinnedToast: string;
+    unpinnedToast: string;
+    pinError: string;
+    kickTitle: string;
+    kickDescription: string;
+    kickConfirm: string;
+    kickError: string;
+    stageError: string;
+    stageDisabled: string;
+    stageGrantNoEffect: string;
+    stageOverflow: string;
+    chatEveryone: string;
+    chatEdited: string;
+    chatPinned: string;
+    chatLoadOlder: string;
+    chatRateLimited: string;
+    chatDelete: string;
+    chatEdit: string;
+    chatPin: string;
+    chatUnpin: string;
+    chatSave: string;
+    waitingSkeleton: string;
+};
+
+declare function StudioRoom({ session, meeting, control, onRefreshStatus, onRejoin, labels, reducedMotion, embed, chrome, playerOrigin, windowGate, initialCameraOn, initialMuted, }: {
+    session: StudioSession;
+    meeting: StudioMeetingHandle;
+    control: StudioControlActions;
+    onRefreshStatus?: () => Promise<void>;
+    onRejoin?: () => void;
+    reducedMotion: boolean;
+    labels: StudioRoomLabels;
+    embed?: boolean;
+    chrome?: ReactNode;
+    playerOrigin?: string;
+    windowGate?: {
+        reportDuplicate: () => void;
+    };
+    initialCameraOn?: boolean;
+    initialMuted?: boolean;
+}): react.JSX.Element;
+
+declare function StudioSkeleton(): react.JSX.Element;
+
+declare function StudioGuestLobby({ reducedMotion, cameraOn, muted, displayName, showName, joining, waitingForHost, error, labels, onCameraChange, onMutedChange, onDisplayNameChange, onJoin, }: {
+    reducedMotion: boolean;
+    cameraOn: boolean;
+    muted: boolean;
+    displayName: string;
+    showName: boolean;
+    joining: boolean;
+    waitingForHost: boolean;
+    error: string | null;
+    labels: {
+        title: string;
+        hint: string;
+        name: string;
+        join: string;
+        waitingForHost: string;
+        camera: string;
+        mic: string;
+    };
+    onCameraChange: (on: boolean) => void;
+    onMutedChange: (muted: boolean) => void;
+    onDisplayNameChange: (name: string) => void;
+    onJoin: () => void;
+}): react.JSX.Element;
+
+type StudioWindowGateContextValue = {
+    reportDuplicate: () => void;
+};
+declare const StudioWindowGateContext: react.Context<StudioWindowGateContextValue>;
+declare function useStudioWindowGate(): StudioWindowGateContextValue;
+declare function StudioWindowGate({ lockKey, allowTakeover, labels, children, }: {
+    lockKey: string;
+    allowTakeover?: boolean;
+    labels: {
+        duplicateTitle: string;
+        duplicateDescription: string;
+        duplicateDescriptionNoTakeover: string;
+        duplicateTakenOver: string;
+        duplicateAction: string;
+    };
+    children: ReactNode;
+}): react.JSX.Element;
+
+declare function LivoHostStudio({ token, apiUrl, labels, redeemError, embed, chrome, playerOrigin, theme, }: {
+    token: string;
+    apiUrl?: string;
+    labels: StudioRoomLabels;
+    redeemError?: string;
+    embed?: boolean;
+    chrome?: ReactNode;
+    playerOrigin?: string;
+    theme?: string | null;
+}): react.JSX.Element;
+
+type StudioLobbyLabels = {
+    title: string;
+    hint: string;
+    name: string;
+    join: string;
+    waitingForHost: string;
+    camera: string;
+    mic: string;
+    joinError: string;
+    joinBusy: string;
+    endedTitle: string;
+};
+declare function LivoGuestStudio({ token, apiUrl, labels, lobbyLabels, embed, playerOrigin, theme, }: {
+    token: string;
+    apiUrl?: string;
+    labels: StudioRoomLabels;
+    lobbyLabels: StudioLobbyLabels;
+    embed?: boolean;
+    playerOrigin?: string;
+    theme?: string | null;
+}): react.JSX.Element;
+
+declare function useRealtimeKitMeeting(authToken: string | null, generation?: number): {
+    meeting: StudioMeetingHandle | null;
+    error: string | null;
+};
+
+declare function usePrefersReducedMotion(): boolean;
+
+declare class StudioApiError extends Error {
+    readonly status: number;
+    readonly body: unknown;
+    constructor(status: number, message: string, body: unknown);
+}
+declare function redeemStudioHost(token: string, apiUrl?: string, fetchFn?: typeof fetch): Promise<StudioSession>;
+declare function joinStudioGuest(token: string, input: {
+    displayName: string;
+    guestId: string;
+}, apiUrl?: string, fetchFn?: typeof fetch): Promise<StudioSession>;
+declare function getStudioJoinStatus(token: string, apiUrl?: string, fetchFn?: typeof fetch): Promise<{
+    ready: boolean;
+    streamStatus: string | null;
+} | "ended">;
+
+export { LivoGuestStudio, LivoHostStudio, StudioApiError, type StudioControlActions, StudioControlClient, type StudioControlClientOptions, StudioControlError, StudioGuestLobby, type StudioLobbyLabels, type StudioMeetingHandle, type StudioRole, StudioRoom, type StudioRoomLabels, type StudioSession, StudioSkeleton, StudioWindowGate, StudioWindowGateContext, controlActionsFromClient, createStudioControlClient, getStudioJoinStatus, joinStudioGuest, redeemStudioHost, studioErrorCode, studioRoomLabels, usePrefersReducedMotion, useRealtimeKitMeeting, useStudioWindowGate };