Class GetTranscriptArgs

Arguments for the asynchronous `get_transcript_async` route. Exactly one of `file_id`, `path`, or `url` must be supplied via `file_id_or_url` to identify the audio or video asset to transcribe.

Inheritance

object

GetTranscriptArgs

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Dropbox.Api.Riviera

Assembly: Dropbox.Api.dll

Syntax

public class GetTranscriptArgs

Constructors

GetTranscriptArgs(FileIdOrUrl, TimestampLevel, string, string)

Initializes a new instance of the GetTranscriptArgs class.

Declaration

public GetTranscriptArgs(FileIdOrUrl fileIdOrUrl = null, TimestampLevel timestampLevel = null, string includedSpecialWords = "", string audioLanguage = "")

Parameters

Type	Name	Description
FileIdOrUrl	fileIdOrUrl	Identifier of the media asset to transcribe. Callers must set exactly one of the FileIdOrUrl variants. The referenced asset must be an audio or video file in a supported format (see the route description for the list); requests against files with no audio track return a no_audio_error.
TimestampLevel	timestampLevel	Granularity of the time offsets returned for each transcript segment. Defaults to SENTENCE when the field is omitted. - SENTENCE: one segment per spoken sentence (recommended). - WORD: one segment per word, useful for fine-grained alignment such as captioning or highlight-as-you-listen experiences.
string	includedSpecialWords	Comma-delimited list of non-lexical filler words to preserve in the transcript output, e.g. "uh, ah, uhm". By default these fillers are stripped. Unrecognized tokens are ignored. Leave empty to use the default filtering behavior.
string	audioLanguage	Optional ISO 639-1 two-letter language code hinting the spoken language of the source audio (e.g. "en", "ja"). When empty, the service auto-detects the language; supplying a hint improves accuracy and latency for short or ambiguous clips. Unsupported languages fall back to auto-detection.

Properties

AudioLanguage

Optional ISO 639-1 two-letter language code hinting the spoken language of the source audio (e.g. "en", "ja"). When empty, the service auto-detects the language; supplying a hint improves accuracy and latency for short or ambiguous clips. Unsupported languages fall back to auto-detection.

Declaration

public string AudioLanguage { get; protected set; }

Property Value

Type	Description
string

FileIdOrUrl

Identifier of the media asset to transcribe. Callers must set exactly one of the `FileIdOrUrl` variants. The referenced asset must be an audio or video file in a supported format (see the route description for the list); requests against files with no audio track return a `no_audio_error`.

Declaration

public FileIdOrUrl FileIdOrUrl { get; protected set; }

Property Value

Type	Description
FileIdOrUrl

IncludedSpecialWords

Comma-delimited list of non-lexical filler words to preserve in the transcript output, e.g. `"uh, ah, uhm"`. By default these fillers are stripped. Unrecognized tokens are ignored. Leave empty to use the default filtering behavior.

Declaration

public string IncludedSpecialWords { get; protected set; }

Property Value

Type	Description
string

TimestampLevel

Granularity of the time offsets returned for each transcript segment. Defaults to `SENTENCE` when the field is omitted. - SENTENCE: one segment per spoken sentence (recommended). - WORD: one segment per word, useful for fine-grained alignment such as captioning or highlight-as-you-listen experiences.

Declaration

public TimestampLevel TimestampLevel { get; protected set; }

Property Value

Type	Description
TimestampLevel