Manage videos
The IndexesVideosWrapper
class provides methods to manage the videos you’ve uploaded to the platform.
Methods
Retrieve video information
Description: This method retrieves information about the specified video.
Function signature and example:
Parameters:
The VideosRetrieveRequest
interface has the following properties:
Return value: Returns a HttpResponsePromise
that resolves to a VideosRetrieveResponse
object representing the retrieved video.
The VideosRetrieveResponse
interface contains the following properties:
The VideosRetrieveResponseSystemMetadata
interface contains the following properties:
The HlsObject
interface contains the following properties:
The VideosRetrieveResponseEmbedding
interface contains the following properties:
The VideosRetrieveResponseEmbeddingVideoEmbedding
interface contains the following properties:
The VideoSegment
interface extends AudioSegment
and contains the following properties:
The TranscriptionDataItem
interface contains the following properties:
API Reference: Retrieve video information page.
List videos
Description: This method iterates through a paginated list of the videos in the specified index based on the provided parameters. By default, the platform returns your videos sorted by creation date, with the newest at the top of the list.
Function signature and example:
Parameters:
Return value: Returns a Promise
that resolves to a Page<VideoVector>
object that implements AsyncIterable
, allowing you to iterate through the paginated list of videos.
The Page
class contains the following properties and methods:
The VideoVector
interface contains the following properties:
The VideoVectorSystemMetadata
interface contains the following properties:
API Reference: List videos.
Update video information
Description: This method updates the title and the metadata of a video.
Function signature and example:
Parameters:
The VideosUpdateRequest
interface defines the parameters for updating a video’s information:
Return value: Returns an HttpResponsePromise
that resolves to void
.
API Reference: Update video information.
Delete video information
Description: This method deletes all the information about the specified video. This action cannot be undone.
Function signature and example:
Parameters:
Return value: Returns an HttpResponsePromise
that resolves to void
.
API Reference: Delete video information.