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

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

export interface HLSConfig {
  /**
   * A list of meeting URL which needs to be streamed as HLS feed, only one URL is currently supported, all entries
   * except the first one will be ignored.
   */
  variants?: Array<HLSMeetingURLVariant>;
  /**
   * pass in this field if recording needs to be turned on as well
   */
  recording?: {
    /**
     * if the desired end result is a mp4 file per HLS layer, false by default
     */
    singleFilePerLayer?: boolean;
    /**
     * if the desired end result is a zip of m3u8 and all the chunks, false by default
     */
    hlsVod?: boolean;
  };
}

export interface StopHLSConfig extends HLSConfig {
  stop_reason?: string;
}

export interface HLSMeetingURLVariant {
  /**
   * This meeting URL is opened in a headless chrome instance for generating the HLS feed.
   * Make sure this URL leads the joiner straight to the room without any preview screen or requiring additional clicks.
   */
  meetingURL: string;
  /**
   * additional metadata for this URL for example - landscape/portrait
   */
  metadata?: string;
}

export interface HLSTimedMetadata {
  payload: string;
  duration: number; // Duration in seconds
}