ListAudioMatchClips

Returns a list of audio 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

Example

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

/action=ListAudioMatchClips&database=music
                           &start=1
                           &maxresults=10
                           &metadata=true

Response

The response always includes the following information for each clip:

  • identifier - The identifier for the clip.
  • duration - The duration of the clip in seconds.
  • features - The number of features extracted from the clip.
  • hasaudiodata - Indicates whether the audio is stored in the database. If this element contains the value false, the audio has been discarded and only the training is stored in the database. See NullAudioMatchAudioData.

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

<autnresponse>
  <action>LISTAUDIOMATCHCLIPS</action>
  <response>SUCCESS</response>
  <responsedata>
    <clip>
      <identifier>694158bb7c12adb8c71af8937a15d896</identifier>
      <duration>24</duration>
      <features>117</features>
      <hasaudiodata>true</hasaudiodata>
      <metadata>
        <item>
          <key>composer</key>
          <value>mozart</value>
        </item>
      </metadata>
    </clip>
  </responsedata>
</autnresponse>