Media Server 24.4
IDOL Media Server Help

# ListSpeakers

Returns a list of speakers in a specified database. The action can also return information about the audio samples associated with each speaker.

Type: synchronous

Parameter | Description | Required
--- | --- | ---
`audiostatus` | A Boolean value (default `false`) that specifies whether to list the audio samples for each speaker. | No
`database` | The name of the speaker database to query. | Yes
`identifier` | A comma-separated list of identifiers to specify the speakers to list. If you do not set this parameter, Media Server lists all of the speakers in the specified database. | No
`metadata` | A Boolean value (default false) that specifies whether to return the metadata associated with each speaker. | No

## Example

The following example lists the speakers in the `news` database.

    /action=ListSpeakers&database=news
                        &audiostatus=true
                        &metadata=true

## Response

The following XML is an example response:

    <autnresponse>
      <action>LISTSPEAKERS</action>
      <response>SUCCESS</response>
      <responsedata>
        <entry>
          <identifier>newsreader</identifier>
          <numaudio>2</numaudio>
          <numtrained>2</numtrained>
          <numfailed>0</numfailed>
          <numuntrained>0</numuntrained>
          <audios>
            <audio>
              <label>0fa6fc519bce4bdf81c335b04c23ed1b</label>
              <status>trained</status>
              <hasaudiodata>true</hasaudiodata>
            </audio>
            <audio>
              <label>70eca429eac320c4cc812488c2adc7d8</label>
              <status>trained</status>
              <hasaudiodata>true</hasaudiodata>
            </audio>
          </audios>
          <metadata>
            <item>
              <key>category</key>
              <value>newsreaders</value>
            </item>
          </metadata>
        </entry>
        ...
      </responsedata>
    </autnresponse>

The response can include the following information for each speaker:

- `identifier` - The identifier for the speaker.
- `numaudio` - The total number of audio samples.
- `numtrained` - The number of audio samples successfully used for training.
- `numfailed` - The number of audio samples for which training was attempted but failed.
- `numuntrained` - The number of audio samples for which training has not yet been attempted.

- `audios` - Each `audio` element describes an audio sample that is associated with the speaker. This information is only present in the response when you set the action parameter `audiostatus=true`.

  - The `label` element provides the label for the audio sample.

  - The `status` element indicates the status of training:

    - `trained` indicates that training was successful.
    - `untrained` indicates that training has not been attempted. To run training use the action BuildSpeaker or BuildAllSpeakers.
    - `failed` indicates that Media Server could not use the audio for training. To remove the failed audio sample use the action RemoveSpeakerAudio.
  - The `hasaudiodata` element indicates whether the audio sample is stored in the database. If this element contains the value `false`, the audio sample has been discarded and only the training is stored in the database. See NullSpeakerAudioData.
- `metadata` - Custom metadata that you added to the speaker. To see the metadata you must set the action parameter `metadata` to `TRUE`.

Copyright 2024 Open Text
Version 24.4 | Last updated September 2024

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL Media Server 24.4

Topic Title: ListSpeakers