Interface Webcast

interface Webcast {
    attendeeJoinMethod?: LiteralString<"Anonymous" | "Registration">;
    backgroundImages: { scaleSize: string; url: string }[];
    categories: { categoryId: string; fullpath: string; name: string }[];
    description: string;
    endDate: string;
    estimatedAttendees: number;
    eventUrl: string;
    id: string;
    isFeatured: boolean;
    linkedVideoId?: null | string;
    listingType: WebcastAccessControl;
    lobbyTimeMinutes: number;
    preProduction: { duration: string; groupIds: string[]; userIds: string[] };
    shortcutName?: null | string;
    shortcutNameUrl?: null | string;
    startDate: string;
    tags: string[];
    title: string;
    unlisted: boolean;
}

Properties

attendeeJoinMethod?: LiteralString<"Anonymous" | "Registration">

Attendee join method. Only required when 'accesscontrol' is Public. Default is 'Registration'. When set to 'Anonymous', no attendee specific details are collected or registered.

backgroundImages: { scaleSize: string; url: string }[]
categories: { categoryId: string; fullpath: string; name: string }[]
description: string
endDate: string
estimatedAttendees: number
eventUrl: string
id: string
isFeatured: boolean
linkedVideoId?: null | string
lobbyTimeMinutes: number
preProduction: { duration: string; groupIds: string[]; userIds: string[] }

Type declaration

  • duration: string

    format: HH:MM

  • groupIds: string[]
  • userIds: string[]
shortcutName?: null | string
shortcutNameUrl?: null | string
startDate: string
tags: string[]
title: string
unlisted: boolean