Class Video

constructor

• new Video(api: TAKAPI): Video

  Parameters

  • api: TAKAPI

  Returns Video

schema

cli

• cli(args: ParsedArgs): Promise<string | object>

  Parameters

  • args: ParsedArgs

  Returns Promise<string | object>

create

• create(
      connection: {
          active: boolean;
          alias: string;
          feeds: { active: boolean; alias: string; url: string; uuid?: string }[];
          groups?: string[];
          uuid?: string;
      },
  ): Promise<
      {
          active: boolean;
          alias: string;
          classification: string
          | null;
          feeds: {
              active: boolean;
              alias: string;
              bitrate: number | null;
              bufferTime: string;
              classification: string | null;
              fov: string | null;
              heading: string | null;
              height: number | null;
              ignoreEmbeddedKLV: string;
              latitude: string | null;
              longitude: string | null;
              macAddress: string;
              networkTimeout: string;
              order: number | null;
              range: string | null;
              roverPort: string;
              rtspReliable: string;
              source: string | null;
              thumbnail: string | null;
              url: string;
              uuid: string;
              width: number | null;
          }[];
          thumbnail: string
          | null;
          uuid: string;
      },
  >

  Parameters

  • connection: {
        active: boolean;
        alias: string;
        feeds: { active: boolean; alias: string; url: string; uuid?: string }[];
        groups?: string[];
        uuid?: string;
    }

  Returns Promise<
      {
          active: boolean;
          alias: string;
          classification: string
          | null;
          feeds: {
              active: boolean;
              alias: string;
              bitrate: number | null;
              bufferTime: string;
              classification: string | null;
              fov: string | null;
              heading: string | null;
              height: number | null;
              ignoreEmbeddedKLV: string;
              latitude: string | null;
              longitude: string | null;
              macAddress: string;
              networkTimeout: string;
              order: number | null;
              range: string | null;
              roverPort: string;
              rtspReliable: string;
              source: string | null;
              thumbnail: string | null;
              url: string;
              uuid: string;
              width: number | null;
          }[];
          thumbnail: string
          | null;
          uuid: string;
      },
  >

delete

• delete(uid: string): Promise<void>

  Parameters

  • uid: string

  Returns Promise<void>

get

• get(
      uid: string,
  ): Promise<
      {
          active: boolean;
          alias: string;
          classification: string
          | null;
          feeds: {
              active: boolean;
              alias: string;
              bitrate: number | null;
              bufferTime: string;
              classification: string | null;
              fov: string | null;
              heading: string | null;
              height: number | null;
              ignoreEmbeddedKLV: string;
              latitude: string | null;
              longitude: string | null;
              macAddress: string;
              networkTimeout: string;
              order: number | null;
              range: string | null;
              roverPort: string;
              rtspReliable: string;
              source: string | null;
              thumbnail: string | null;
              url: string;
              uuid: string;
              width: number | null;
          }[];
          thumbnail: string
          | null;
          uuid: string;
      },
  >

  Parameters

  • uid: string

  Returns Promise<
      {
          active: boolean;
          alias: string;
          classification: string
          | null;
          feeds: {
              active: boolean;
              alias: string;
              bitrate: number | null;
              bufferTime: string;
              classification: string | null;
              fov: string | null;
              heading: string | null;
              height: number | null;
              ignoreEmbeddedKLV: string;
              latitude: string | null;
              longitude: string | null;
              macAddress: string;
              networkTimeout: string;
              order: number | null;
              range: string | null;
              roverPort: string;
              rtspReliable: string;
              source: string | null;
              thumbnail: string | null;
              url: string;
              uuid: string;
              width: number | null;
          }[];
          thumbnail: string
          | null;
          uuid: string;
      },
  >

list

• list(
      query?: { protocol?: string },
  ): Promise<
      {
          videoConnections: {
              active: boolean;
              alias: string;
              classification: string
              | null;
              feeds: {
                  active: boolean;
                  alias: string;
                  bitrate: number | null;
                  bufferTime: string;
                  classification: string | null;
                  fov: string | null;
                  heading: string | null;
                  height: number | null;
                  ignoreEmbeddedKLV: string;
                  latitude: string | null;
                  longitude: string | null;
                  macAddress: string;
                  networkTimeout: string;
                  order: number | null;
                  range: string | null;
                  roverPort: string;
                  rtspReliable: string;
                  source: string | null;
                  thumbnail: string | null;
                  url: string;
                  uuid: string;
                  width: number | null;
              }[];
              thumbnail: string
              | null;
              uuid: string;
          }[];
      },
  >

  Parameters

  • query: { protocol?: string } = {}

  Returns Promise<
      {
          videoConnections: {
              active: boolean;
              alias: string;
              classification: string
              | null;
              feeds: {
                  active: boolean;
                  alias: string;
                  bitrate: number | null;
                  bufferTime: string;
                  classification: string | null;
                  fov: string | null;
                  heading: string | null;
                  height: number | null;
                  ignoreEmbeddedKLV: string;
                  latitude: string | null;
                  longitude: string | null;
                  macAddress: string;
                  networkTimeout: string;
                  order: number | null;
                  range: string | null;
                  roverPort: string;
                  rtspReliable: string;
                  source: string | null;
                  thumbnail: string | null;
                  url: string;
                  uuid: string;
                  width: number | null;
              }[];
              thumbnail: string
              | null;
              uuid: string;
          }[];
      },
  >

update

• update(
      connection: {
          active: boolean;
          alias: string;
          feeds: { active: boolean; alias: string; url: string; uuid?: string }[];
          uuid?: string;
      },
  ): Promise<
      {
          active: boolean;
          alias: string;
          classification: string
          | null;
          feeds: {
              active: boolean;
              alias: string;
              bitrate: number | null;
              bufferTime: string;
              classification: string | null;
              fov: string | null;
              heading: string | null;
              height: number | null;
              ignoreEmbeddedKLV: string;
              latitude: string | null;
              longitude: string | null;
              macAddress: string;
              networkTimeout: string;
              order: number | null;
              range: string | null;
              roverPort: string;
              rtspReliable: string;
              source: string | null;
              thumbnail: string | null;
              url: string;
              uuid: string;
              width: number | null;
          }[];
          thumbnail: string
          | null;
          uuid: string;
      },
  >

  Parameters

  • connection: {
        active: boolean;
        alias: string;
        feeds: { active: boolean; alias: string; url: string; uuid?: string }[];
        uuid?: string;
    }

  Returns Promise<
      {
          active: boolean;
          alias: string;
          classification: string
          | null;
          feeds: {
              active: boolean;
              alias: string;
              bitrate: number | null;
              bufferTime: string;
              classification: string | null;
              fov: string | null;
              heading: string | null;
              height: number | null;
              ignoreEmbeddedKLV: string;
              latitude: string | null;
              longitude: string | null;
              macAddress: string;
              networkTimeout: string;
              order: number | null;
              range: string | null;
              roverPort: string;
              rtspReliable: string;
              source: string | null;
              thumbnail: string | null;
              url: string;
              uuid: string;
              width: number | null;
          }[];
          thumbnail: string
          | null;
          uuid: string;
      },
  >