Opt Out Speaker
voiceid_opt_out_speaker | R Documentation |
Opts out a speaker from Voice ID¶
Description¶
Opts out a speaker from Voice ID. A speaker can be opted out regardless of whether or not they already exist in Voice ID. If they don't yet exist, a new speaker is created in an opted out state. If they already exist, their existing status is overridden and they are opted out. Enrollment and evaluation authentication requests are rejected for opted out speakers, and opted out speakers have no voice embeddings stored in Voice ID.
Usage¶
Arguments¶
DomainId
[required] The identifier of the domain that contains the speaker.
SpeakerId
[required] The identifier of the speaker you want opted-out.
Value¶
A list with the following syntax:
list(
Speaker = list(
CreatedAt = as.POSIXct(
"2015-01-01"
),
CustomerSpeakerId = "string",
DomainId = "string",
GeneratedSpeakerId = "string",
LastAccessedAt = as.POSIXct(
"2015-01-01"
),
Status = "ENROLLED"|"EXPIRED"|"OPTED_OUT"|"PENDING",
UpdatedAt = as.POSIXct(
"2015-01-01"
)
)
)