Class Videos

Videos

Videos and pre-recorded content are used interchangeably for the API. This class will allow you to manage the videos for a given organizer account.

Hierarchy

  • Videos

Constructors

constructor

Properties

routeCreateVideo routeDeleteVideo routeListVideo routeMainVideo routePreviewVideo routeSetMainImage routeUpdateVideo routeUploadMainVideo routeViewVideo

Methods

createVideo deleteVideo listVideos updateVideo uploadImage uploadMainVideo uploadPreviewVideo viewVideo

Constructors

constructor

Properties

Static Private routeCreateVideo

routeCreateVideo: Route = ...

Static Private routeDeleteVideo

routeDeleteVideo: Route = ...

Static Private routeListVideo

routeListVideo: Route = ...

Static Private routeMainVideo

routeMainVideo: Route = ...

Static Private routePreviewVideo

routePreviewVideo: Route = ...

Static Private routeSetMainImage

routeSetMainImage: Route = ...

Static routeUpdateVideo

routeUpdateVideo: Route = ...

Static Private routeUploadMainVideo

routeUploadMainVideo: Route = ...

Static Private routeViewVideo

routeViewVideo: Route = ...

Methods

Static createVideo

  • Create a new video (aka: pre-recorded content)

    See

    Videos Create Video - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • data: object

      The data that will be used to created the video

    • Optional query: null | object

      Data that will be passed in the query string as a parameter.

    • Optional options: null | object

      Further options that can be used to modify the request.

    Returns Promise<any>

Static deleteVideo

  • Remove pre-recorded content/video so that it is no longer accessible.

    See

    Videos Delete Video - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • video_id: string

      The id of the video.

    • data: object

      Data that will be passed in the body of the request.

    • Optional query: null | object

      Data that will be passed in the query string as a parameter.

    • Optional options: null | object

      Further options that can be used to modify the request.

    Returns Promise<any>

Static listVideos

  • Retrieves a list of videos/pre-recorded content that have previously uploaded. The list can be paginated and sorted with the query options.

    See

    Videos Create Video - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • Optional query: null | object

      Data that will be passed in the query string as a parameter.

    • Optional options: null | object

      Further options that can be used to modify the request.

    Returns Promise<any>

Static updateVideo

  • Update a video/pre-recorded content that has been previously created.

    See

    Videos Update Video - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • video_id: string

      The id of the video

    • data: object

      Data that will be passed in the body of the request.

    • Optional query: null | object

      Data that will be passed in the query string as a parameter.

    • Optional options: null | object

      Further options that can be used to modify the request.

    Returns Promise<any>

Static uploadImage

  • Sets the main image for the video/pre-recorded content.

    See

    Videos Upload Main Image - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • video_id: string

      The id of the video this be the main video for.

    • filename: string

      Name of file.

    • file: any

      Either the location of the file OR a file object. If in a browser, pass in the file object. If executing on a node backend, pass in the location of the file on the server.

    • data: object

      Data that will be passed in the body of the request.

    • Optional query: null | object

      Data that will be passed in the query string as a parameter.

    • Optional options: null | object

      Further options that can be used to modify the request.

    Returns Promise<any>

Static uploadMainVideo

  • Uploads the video file that will be used as the main video for the pre-recorded content.

    See

    Videos Set Main Video File - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • file: any

      Either the location of the file OR a file object. If in a browser, pass in the file object. If executing on a node backend, pass in the location of the file on the server.

    • video_id: string

      The id of the video this be the main video for.

    • data: AnyObject

      Data that will be passed in the body of the request.

    • Optional query: null | AnyObject

      Data that will be passed in the query string as a parameter.

    • Optional options: null | object

      Further options that can be used to modify the request.

    Returns Promise<any>

Static uploadPreviewVideo

  • Uploads the video file that will be used as the trailer/preview for the pre-recorded content.

    See

    Videos Set Main Video File - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • file: any

      Either the location of the file OR a file object. If in a browser, pass in the file object. If executing on a node backend, pass in the location of the file on the server.

    • video_id: string

      The id of the video this be the main video for.

    • data: object

      Data that will be passed in the body of the request.

    • Optional query: null | object

      Data that will be passed in the query string as a parameter.

    • Optional options: null | object

      Further options that can be used to modify the request.

    Returns Promise<any>

Static viewVideo

  • Retrieve a single video/pre-recorded content that has been uploaded.

    See

    Videos Single Video - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • video_id: string

      The id of the video you want to retrieve.

    • Optional query: null | object

      Data that will be passed in the query string as a parameter.

    • Optional options: null | object

      Further options that can be used to modify the request.

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc