@100mslive/hms-video-store/src/interfaces/role.ts

@100mslive Core SDK which abstracts the complexities of webRTC while providing a reactive store for data management with a unidirectional data flow

import { HMSTranscriptionMode } from './room';
import { SimulcastLayers } from './simulcast-layers';

export type HMSRoleName = string;

export type HMSPermissionType = 'read' | 'write' | 'admin';

export interface HMSRole {
  name: string;
  publishParams: PublishParams;
  subscribeParams: {
    subscribeToRoles: string[];
    maxSubsBitRate: number;
  };
  permissions: {
    endRoom: boolean;
    removeOthers: boolean;
    unmute: boolean;
    mute: boolean;
    changeRole: boolean;
    hlsStreaming: boolean;
    rtmpStreaming: boolean;
    browserRecording: boolean;
    pollRead: boolean;
    pollWrite: boolean;
    whiteboard?: Array<HMSPermissionType>;
    transcriptions?: Record<HMSTranscriptionMode, Array<HMSPermissionType>>;
  };
  priority: number;
}

export interface PublishParams {
  audio: {
    bitRate: number;
    codec: string;
  };
  video: {
    bitRate: number;
    codec: string;
    frameRate: number;
    width: number;
    height: number;
  };
  screen: {
    bitRate: number;
    codec: string;
    frameRate: number;
    width: number;
    height: number;
  };
  allowed: string[];
  simulcast?: {
    video: SimulcastLayers;
    screen: SimulcastLayers;
  };
}