import type VideoType from './VideoType';
import type LiveStreamStatus from './LiveStreamStatus';

export interface VideoPlayerSize {
  width: number;
  height: number;
}

export default interface VideoPlaybackDetails {
  /**
   * A unique identifier of the video.
   */
  videoId: string;
  /**
   * The total duration of the video.
   */
  duration?: number | null;
  /**
   * The caption for the video.
   */
  caption?: string | null;
  /**
   * Video badge type.
   */
  badge?: string | null;
  /**
   * The size of the player.
   */
  playerSize?: VideoPlayerSize | null;
  /**
   * Indicates if the video is associated with a call-to-action (CTA).
   */
  hasCTA?: boolean | null;
  /**
   * The amount of time the video was playing at the time of the event.
   */
  progress?: number | null;
  /**
   * The type of the CTA button, as an uppercase server-side enum value,
   * e.g. "VIEW" "BUY" "SHOP_NOW" "LEARN_MORE". Use this for analytics and
   * branching - it is stable across locales.
   */
  ctaActionType?: string | null;
  /**
   * The url of the CTA button.
   */
  ctaActionURL?: string | null;
  /**
   * The associated feed ID
   */
  feedId?: string | null;
  /**
   * The type of video.
   */
  videoType?: VideoType | null;
  /**
   * The status of the livestream.
   * When videoType is VideoType.Livestream, you could use
   * this property to check the live stream status.
   */
  liveStreamStatus?: LiveStreamStatus | null;
  /**
   * The hashtags associated with the video.
   * An empty array when the video has none.
   */
  hashtags?: string[] | null;
}