ListVideoMatchClips

Returns a list of video clips in a specified database.

Type: synchronous

Parameter Description Required
database The name of the database to query. Yes
identifier A comma-separated list of identifiers to specify the clips to list. If you do not set this parameter, Media Server lists all of the clips in the specified database. No
maxresults The maximum number of clips to return. No
metadata A Boolean value (default false) that specifies whether to return the metadata associated with each clip. No
start The starting point for the list when you set the maxresults parameter. For example, to start listing clips from the tenth clip in the database, set start=10. The entries in the database are indexed from 1. No
trainingoptions A Boolean value (default false) that specifies whether to return the training options set for each clip. No
videostatus A Boolean value (default false) that specifies whether to report the status of training and whether the video data is stored in the database. No

Example

The following example lists up to 10 clips contained in the movies database:

/action=ListVideoMatchClips&database=movies
                           &start=1
                           &maxresults=10
                           &metadata=true

Response

The following XML shows an example response that includes a single video match clip.

<autnresponse>
  <action>LISTVIDEOMATCHCLIPS</action>
  <response>SUCCESS</response>
  <responsedata>
    <entry>
      <identifier>4c34c1225e6a6e62398203a397864ac7</identifier>
      <numvideos>1</numvideos>
      <numtrained>1</numtrained>
      <numfailed>0</numfailed>
      <numuntrained>0</numuntrained>
      <videos>
        <video>
          <label>4c34c1225e6a6e62398203a397864ac7</label>
          <status>trained</status>
          <hasvideodata>true</hasvideodata>
        </video>
      </videos>
      <trainingoptions>
        <trainingoption>
          <key>maximumduration</key>
          <value>30s</value>
        </trainingoption>
      </trainingoptions>
      <metadata>
        <item>
          <key>released</key>
          <value>2021</value>
        </item>
      </metadata>
    </entry>
  </responsedata>
</autnresponse>

The identifier element shows the identifier that was assigned to the clip.

The numtrained element should contain the value 1. If it contains the value 0 and the numfailed element contains the value 1, then training was unsuccessful.

The videos element is present only when you set the action parameter videostatus=true. This element always contains one video, and includes the following information:

  • label always matches the identifier for the clip.
  • status shows the status of training.
  • hasvideodata specifies whether the video clip that was used to train Media Server is stored in the database. If this element contains the value false, the video has been discarded and only the training is stored in the database. See NullVideoMatchVideoData.

The trainingoptions element shows the options that have been set to customize training. You can set training options with the trainingoptions parameter when you run the action TrainVideoMatchClip.

The metadata element contains custom metadata that you have added to the clip using AddVideoMatchClipMetadata. To see the metadata you must set the action parameter metadata to TRUE.