Class RivieraAppRoutes

The routes for the Dropbox.Api.Riviera namespace

Inheritance

object

RivieraAppRoutes

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.Routes

Assembly: Dropbox.Api.dll

Syntax

public class RivieraAppRoutes

Methods

BeginGetKeyframesAsync(FileIdOrUrl, double, bool, AsyncCallback, object)

Begins an asynchronous send to the get keyframes async route.

Declaration

public IAsyncResult BeginGetKeyframesAsync(FileIdOrUrl fileIdOrUrl = null, double sceneChangeThreshold = 0, bool includeImages = false, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
FileIdOrUrl	fileIdOrUrl	Identifier of the video file to extract keyframes from. Callers must set exactly one of the FileIdOrUrl variants. Keyframe extraction is supported for video files only; see the route description for the supported formats. Requests against unsupported formats return unsupported_format_error.
double	sceneChangeThreshold	Sensitivity of scene-change detection. A keyframe is emitted whenever the frame-to-frame scene score crosses this threshold, so a LOWER value yields MORE keyframes. Valid range is (0.0, 1.0]. When omitted (0.0) the service uses a default of 0.3, which is a good starting point for most videos.
bool	includeImages	When true, each returned keyframe includes the JPEG image bytes, base64-encoded, in ApiKeyframe.image_base64. When false, the response contains only per-keyframe metadata (timestamp and scene score) and image_base64 is left empty -- useful when you only need the scene boundaries and want a small response. NOTE: because the field defaults to false in proto3, callers who want images must set this explicitly to true.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
IAsyncResult	An object that represents the asynchronous send request.

BeginGetKeyframesAsync(GetKeyframesArgs, AsyncCallback, object)

Begins an asynchronous send to the get keyframes async route.

Declaration

public IAsyncResult BeginGetKeyframesAsync(GetKeyframesArgs getKeyframesArgs, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
GetKeyframesArgs	getKeyframesArgs	The request parameters.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
IAsyncResult	An object that represents the asynchronous send request.

BeginGetKeyframesAsyncCheck(PollArg, AsyncCallback, object)

Begins an asynchronous send to the get keyframes async check route.

Declaration

public IAsyncResult BeginGetKeyframesAsyncCheck(PollArg pollArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
IAsyncResult	An object that represents the asynchronous send request.

BeginGetKeyframesAsyncCheck(string, AsyncCallback, object)

Begins an asynchronous send to the get keyframes async check route.

Declaration

public IAsyncResult BeginGetKeyframesAsyncCheck(string asyncJobId, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
string	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
IAsyncResult	An object that represents the asynchronous send request.

BeginGetMarkdownAsync(FileIdOrUrl, bool, bool, AsyncCallback, object)

Begins an asynchronous send to the get markdown async route.

Declaration

public IAsyncResult BeginGetMarkdownAsync(FileIdOrUrl fileIdOrUrl = null, bool enableOcr = false, bool embedImages = false, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
FileIdOrUrl	fileIdOrUrl	Identifier of the document to convert. Callers must set exactly one of the FileIdOrUrl variants. The referenced file must be a document in a supported format (see the route description for the list); requests against unsupported formats return unsupported_format_error.
bool	enableOcr	Enable OCR for PDF documents. Processing is slower when enabled.
bool	embedImages	When true, embed images as base64 data URIs in the markdown output. This can significantly increase output size.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
IAsyncResult	An object that represents the asynchronous send request.

BeginGetMarkdownAsync(GetMarkdownArgs, AsyncCallback, object)

Begins an asynchronous send to the get markdown async route.

Declaration

public IAsyncResult BeginGetMarkdownAsync(GetMarkdownArgs getMarkdownArgs, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
GetMarkdownArgs	getMarkdownArgs	The request parameters.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
IAsyncResult	An object that represents the asynchronous send request.

BeginGetMarkdownAsyncCheck(PollArg, AsyncCallback, object)

Begins an asynchronous send to the get markdown async check route.

Declaration

public IAsyncResult BeginGetMarkdownAsyncCheck(PollArg pollArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
IAsyncResult	An object that represents the asynchronous send request.

BeginGetMarkdownAsyncCheck(string, AsyncCallback, object)

Begins an asynchronous send to the get markdown async check route.

Declaration

public IAsyncResult BeginGetMarkdownAsyncCheck(string asyncJobId, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
string	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
IAsyncResult	An object that represents the asynchronous send request.

BeginGetMetadataAsync(FileIdOrUrl, AsyncCallback, object)

Begins an asynchronous send to the get metadata async route.

Declaration

public IAsyncResult BeginGetMetadataAsync(FileIdOrUrl fileIdOrUrl = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
FileIdOrUrl	fileIdOrUrl	Identifier of the file to extract metadata from. Callers must set exactly one of the FileIdOrUrl variants. The kind of metadata returned is determined by the file type: image files return EXIF metadata, audio/video files return media metadata, PDFs return PDF metadata, and MS Office documents (docx, pptx, xlsx) return Office metadata. See the route description for the supported formats. Requests against unsupported formats return unsupported_format_error.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
IAsyncResult	An object that represents the asynchronous send request.

BeginGetMetadataAsync(GetMetadataArgs, AsyncCallback, object)

Begins an asynchronous send to the get metadata async route.

Declaration

public IAsyncResult BeginGetMetadataAsync(GetMetadataArgs getMetadataArgs, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
GetMetadataArgs	getMetadataArgs	The request parameters.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
IAsyncResult	An object that represents the asynchronous send request.

BeginGetMetadataAsyncCheck(PollArg, AsyncCallback, object)

Begins an asynchronous send to the get metadata async check route.

Declaration

public IAsyncResult BeginGetMetadataAsyncCheck(PollArg pollArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
IAsyncResult	An object that represents the asynchronous send request.

BeginGetMetadataAsyncCheck(string, AsyncCallback, object)

Begins an asynchronous send to the get metadata async check route.

Declaration

public IAsyncResult BeginGetMetadataAsyncCheck(string asyncJobId, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
string	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
IAsyncResult	An object that represents the asynchronous send request.

BeginGetOcrAsync(FileIdOrUrl, AsyncCallback, object)

Begins an asynchronous send to the get ocr async route.

Declaration

public IAsyncResult BeginGetOcrAsync(FileIdOrUrl fileIdOrUrl = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
FileIdOrUrl	fileIdOrUrl	Identifier of the file to run OCR on. Callers must set exactly one of the FileIdOrUrl variants. OCR is supported for image files and PDFs, including scanned / non-text PDFs; see the route description for the supported formats. Requests against unsupported formats return unsupported_format_error. NOTE: for the url variant, only Dropbox shared links (www.dropbox.com) are supported. External (non-Dropbox) URLs are not supported and return unsupported_format_error; import the file into Dropbox and reference it by file_id or path instead.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
IAsyncResult	An object that represents the asynchronous send request.

BeginGetOcrAsync(GetOcrArgs, AsyncCallback, object)

Begins an asynchronous send to the get ocr async route.

Declaration

public IAsyncResult BeginGetOcrAsync(GetOcrArgs getOcrArgs, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
GetOcrArgs	getOcrArgs	The request parameters.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
IAsyncResult	An object that represents the asynchronous send request.

BeginGetOcrAsyncCheck(PollArg, AsyncCallback, object)

Begins an asynchronous send to the get ocr async check route.

Declaration

public IAsyncResult BeginGetOcrAsyncCheck(PollArg pollArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
IAsyncResult	An object that represents the asynchronous send request.

BeginGetOcrAsyncCheck(string, AsyncCallback, object)

Begins an asynchronous send to the get ocr async check route.

Declaration

public IAsyncResult BeginGetOcrAsyncCheck(string asyncJobId, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
string	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
IAsyncResult	An object that represents the asynchronous send request.

BeginGetTextAsync(FileIdOrUrl, AsyncCallback, object)

Begins an asynchronous send to the get text async route.

Declaration

public IAsyncResult BeginGetTextAsync(FileIdOrUrl fileIdOrUrl = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
FileIdOrUrl	fileIdOrUrl	Identifier of the document to extract text from. Callers must set exactly one of the FileIdOrUrl variants. Text extraction is supported for common document formats (Word, PowerPoint, Excel, PDF, RTF, and Dropbox document types); see the route description for the supported formats. Requests against unsupported formats return unsupported_format_error. NOTE: for the url variant, only Dropbox shared links (www.dropbox.com) are supported. External (non-Dropbox) URLs are not supported and return unsupported_format_error; import the file into Dropbox and reference it by file_id or path instead.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
IAsyncResult	An object that represents the asynchronous send request.

BeginGetTextAsync(GetTextArgs, AsyncCallback, object)

Begins an asynchronous send to the get text async route.

Declaration

public IAsyncResult BeginGetTextAsync(GetTextArgs getTextArgs, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
GetTextArgs	getTextArgs	The request parameters.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
IAsyncResult	An object that represents the asynchronous send request.

BeginGetTextAsyncCheck(PollArg, AsyncCallback, object)

Begins an asynchronous send to the get text async check route.

Declaration

public IAsyncResult BeginGetTextAsyncCheck(PollArg pollArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
IAsyncResult	An object that represents the asynchronous send request.

BeginGetTextAsyncCheck(string, AsyncCallback, object)

Begins an asynchronous send to the get text async check route.

Declaration

public IAsyncResult BeginGetTextAsyncCheck(string asyncJobId, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
string	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
IAsyncResult	An object that represents the asynchronous send request.

BeginGetTranscriptAsync(FileIdOrUrl, TimestampLevel, string, string, AsyncCallback, object)

Begins an asynchronous send to the get transcript async route.

Declaration

public IAsyncResult BeginGetTranscriptAsync(FileIdOrUrl fileIdOrUrl = null, TimestampLevel timestampLevel = null, string includedSpecialWords = "", string audioLanguage = "", AsyncCallback callback = null, object callbackState = null)

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.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
IAsyncResult	An object that represents the asynchronous send request.

BeginGetTranscriptAsync(GetTranscriptArgs, AsyncCallback, object)

Begins an asynchronous send to the get transcript async route.

Declaration

public IAsyncResult BeginGetTranscriptAsync(GetTranscriptArgs getTranscriptArgs, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
GetTranscriptArgs	getTranscriptArgs	The request parameters.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
IAsyncResult	An object that represents the asynchronous send request.

BeginGetTranscriptAsyncCheck(PollArg, AsyncCallback, object)

Begins an asynchronous send to the get transcript async check route.

Declaration

public IAsyncResult BeginGetTranscriptAsyncCheck(PollArg pollArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
IAsyncResult	An object that represents the asynchronous send request.

BeginGetTranscriptAsyncCheck(string, AsyncCallback, object)

Begins an asynchronous send to the get transcript async check route.

Declaration

public IAsyncResult BeginGetTranscriptAsyncCheck(string asyncJobId, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
string	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
IAsyncResult	An object that represents the asynchronous send request.

EndGetKeyframesAsync(IAsyncResult)

Waits for the pending asynchronous send to the get keyframes async route to complete

Declaration

public LaunchResultBase EndGetKeyframesAsync(IAsyncResult asyncResult)

Parameters

Type	Name	Description
IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
LaunchResultBase	The response to the send request

EndGetKeyframesAsyncCheck(IAsyncResult)

Waits for the pending asynchronous send to the get keyframes async check route to complete

Declaration

public GetKeyframesAsyncCheckResult EndGetKeyframesAsyncCheck(IAsyncResult asyncResult)

Parameters

Type	Name	Description
IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
GetKeyframesAsyncCheckResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

EndGetMarkdownAsync(IAsyncResult)

Waits for the pending asynchronous send to the get markdown async route to complete

Declaration

public LaunchResultBase EndGetMarkdownAsync(IAsyncResult asyncResult)

Parameters

Type	Name	Description
IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
LaunchResultBase	The response to the send request

EndGetMarkdownAsyncCheck(IAsyncResult)

Waits for the pending asynchronous send to the get markdown async check route to complete

Declaration

public GetMarkdownAsyncCheckResult EndGetMarkdownAsyncCheck(IAsyncResult asyncResult)

Parameters

Type	Name	Description
IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
GetMarkdownAsyncCheckResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

EndGetMetadataAsync(IAsyncResult)

Waits for the pending asynchronous send to the get metadata async route to complete

Declaration

public LaunchResultBase EndGetMetadataAsync(IAsyncResult asyncResult)

Parameters

Type	Name	Description
IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
LaunchResultBase	The response to the send request

EndGetMetadataAsyncCheck(IAsyncResult)

Waits for the pending asynchronous send to the get metadata async check route to complete

Declaration

public GetMetadataAsyncCheckResult EndGetMetadataAsyncCheck(IAsyncResult asyncResult)

Parameters

Type	Name	Description
IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
GetMetadataAsyncCheckResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

EndGetOcrAsync(IAsyncResult)

Waits for the pending asynchronous send to the get ocr async route to complete

Declaration

public LaunchResultBase EndGetOcrAsync(IAsyncResult asyncResult)

Parameters

Type	Name	Description
IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
LaunchResultBase	The response to the send request

EndGetOcrAsyncCheck(IAsyncResult)

Waits for the pending asynchronous send to the get ocr async check route to complete

Declaration

public GetOcrAsyncCheckResult EndGetOcrAsyncCheck(IAsyncResult asyncResult)

Parameters

Type	Name	Description
IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
GetOcrAsyncCheckResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

EndGetTextAsync(IAsyncResult)

Waits for the pending asynchronous send to the get text async route to complete

Declaration

public LaunchResultBase EndGetTextAsync(IAsyncResult asyncResult)

Parameters

Type	Name	Description
IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
LaunchResultBase	The response to the send request

EndGetTextAsyncCheck(IAsyncResult)

Waits for the pending asynchronous send to the get text async check route to complete

Declaration

public GetTextAsyncCheckResult EndGetTextAsyncCheck(IAsyncResult asyncResult)

Parameters

Type	Name	Description
IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
GetTextAsyncCheckResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

EndGetTranscriptAsync(IAsyncResult)

Waits for the pending asynchronous send to the get transcript async route to complete

Declaration

public LaunchResultBase EndGetTranscriptAsync(IAsyncResult asyncResult)

Parameters

Type	Name	Description
IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
LaunchResultBase	The response to the send request

EndGetTranscriptAsyncCheck(IAsyncResult)

Waits for the pending asynchronous send to the get transcript async check route to complete

Declaration

public GetTranscriptAsyncCheckResult EndGetTranscriptAsyncCheck(IAsyncResult asyncResult)

Parameters

Type	Name	Description
IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
GetTranscriptAsyncCheckResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

GetKeyframesAsyncAsync(FileIdOrUrl, double, bool)

Asynchronous scene-change keyframe extraction for video files. Detects scene changes in the source video and returns one representative keyframe per detected scene, each tagged with its timestamp (seconds from the start of the video) and scene-change score. Set `include_images = true` to also receive each frame as a base64-encoded JPEG; when the field is omitted the response carries keyframe metadata only. Supported video formats: .3gp, .3gpp, .3gpp2, .asf, .avi, .dv, .flv, .m2t, .m2ts, .m4v, .mkv, .mov, .mp4, .mpeg, .mpg, .mts, .mxf, .oggtheora, .ogv, .rm, .ts, .vob, .webm, .wmv. Unsupported formats return an `unsupported_format_error`. Limits: the source file must be at most 10 GB. To keep responses within service limits the number of keyframes and the total image payload are bounded; requests that would exceed these limits return a `limit_exceeded_error` -- raise `scene_change_threshold` or set `include_images = false` to stay within bounds.

Declaration

public Task<LaunchResultBase> GetKeyframesAsyncAsync(FileIdOrUrl fileIdOrUrl = null, double sceneChangeThreshold = 0, bool includeImages = false)

Parameters

Type	Name	Description
FileIdOrUrl	fileIdOrUrl	Identifier of the video file to extract keyframes from. Callers must set exactly one of the FileIdOrUrl variants. Keyframe extraction is supported for video files only; see the route description for the supported formats. Requests against unsupported formats return unsupported_format_error.
double	sceneChangeThreshold	Sensitivity of scene-change detection. A keyframe is emitted whenever the frame-to-frame scene score crosses this threshold, so a LOWER value yields MORE keyframes. Valid range is (0.0, 1.0]. When omitted (0.0) the service uses a default of 0.3, which is a good starting point for most videos.
bool	includeImages	When true, each returned keyframe includes the JPEG image bytes, base64-encoded, in ApiKeyframe.image_base64. When false, the response contains only per-keyframe metadata (timestamp and scene score) and image_base64 is left empty -- useful when you only need the scene boundaries and want a small response. NOTE: because the field defaults to false in proto3, callers who want images must set this explicitly to true.

Returns

Type	Description
Task<LaunchResultBase>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

GetKeyframesAsyncAsync(GetKeyframesArgs)

Asynchronous scene-change keyframe extraction for video files. Detects scene changes in the source video and returns one representative keyframe per detected scene, each tagged with its timestamp (seconds from the start of the video) and scene-change score. Set `include_images = true` to also receive each frame as a base64-encoded JPEG; when the field is omitted the response carries keyframe metadata only. Supported video formats: .3gp, .3gpp, .3gpp2, .asf, .avi, .dv, .flv, .m2t, .m2ts, .m4v, .mkv, .mov, .mp4, .mpeg, .mpg, .mts, .mxf, .oggtheora, .ogv, .rm, .ts, .vob, .webm, .wmv. Unsupported formats return an `unsupported_format_error`. Limits: the source file must be at most 10 GB. To keep responses within service limits the number of keyframes and the total image payload are bounded; requests that would exceed these limits return a `limit_exceeded_error` -- raise `scene_change_threshold` or set `include_images = false` to stay within bounds.

Declaration

public Task<LaunchResultBase> GetKeyframesAsyncAsync(GetKeyframesArgs getKeyframesArgs)

Parameters

Type	Name	Description
GetKeyframesArgs	getKeyframesArgs	The request parameters

Returns

Type	Description
Task<LaunchResultBase>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

GetKeyframesAsyncCheckAsync(PollArg)

Returns the status or result of specified get_keyframes_async task.

Declaration

public Task<GetKeyframesAsyncCheckResult> GetKeyframesAsyncCheckAsync(PollArg pollArg)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters

Returns

Type	Description
Task<GetKeyframesAsyncCheckResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

GetKeyframesAsyncCheckAsync(string)

Returns the status or result of specified get_keyframes_async task.

Declaration

public Task<GetKeyframesAsyncCheckResult> GetKeyframesAsyncCheckAsync(string asyncJobId)

Parameters

Type	Name	Description
string	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

Returns

Type	Description
Task<GetKeyframesAsyncCheckResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

GetMarkdownAsyncAsync(FileIdOrUrl, bool, bool)

Asynchronous document-to-markdown conversion for supported file formats. Supported formats: .binder, .docx, .html, .paper, .papert, .pptx, .xlsx, .gsheet, .ods, .pdf. Unsupported formats return an `unsupported_format_error`. Size limit: the source file must be at most 50 MB. Larger files are rejected.

Declaration

public Task<LaunchResultBase> GetMarkdownAsyncAsync(FileIdOrUrl fileIdOrUrl = null, bool enableOcr = false, bool embedImages = false)

Parameters

Type	Name	Description
FileIdOrUrl	fileIdOrUrl	Identifier of the document to convert. Callers must set exactly one of the FileIdOrUrl variants. The referenced file must be a document in a supported format (see the route description for the list); requests against unsupported formats return unsupported_format_error.
bool	enableOcr	Enable OCR for PDF documents. Processing is slower when enabled.
bool	embedImages	When true, embed images as base64 data URIs in the markdown output. This can significantly increase output size.

Returns

Type	Description
Task<LaunchResultBase>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

GetMarkdownAsyncAsync(GetMarkdownArgs)

Asynchronous document-to-markdown conversion for supported file formats. Supported formats: .binder, .docx, .html, .paper, .papert, .pptx, .xlsx, .gsheet, .ods, .pdf. Unsupported formats return an `unsupported_format_error`. Size limit: the source file must be at most 50 MB. Larger files are rejected.

Declaration

public Task<LaunchResultBase> GetMarkdownAsyncAsync(GetMarkdownArgs getMarkdownArgs)

Parameters

Type	Name	Description
GetMarkdownArgs	getMarkdownArgs	The request parameters

Returns

Type	Description
Task<LaunchResultBase>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

GetMarkdownAsyncCheckAsync(PollArg)

Returns the status or result of specified get_markdown_async task.

Declaration

public Task<GetMarkdownAsyncCheckResult> GetMarkdownAsyncCheckAsync(PollArg pollArg)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters

Returns

Type	Description
Task<GetMarkdownAsyncCheckResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

GetMarkdownAsyncCheckAsync(string)

Returns the status or result of specified get_markdown_async task.

Declaration

public Task<GetMarkdownAsyncCheckResult> GetMarkdownAsyncCheckAsync(string asyncJobId)

Parameters

Type	Name	Description
string	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

Returns

Type	Description
Task<GetMarkdownAsyncCheckResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

GetMetadataAsyncAsync(FileIdOrUrl)

Asynchronous file metadata extraction for supported file formats. The kind of metadata returned depends on the file type: - Image (EXIF) formats: .3fr, .arw, .avif, .bmp, .cr2, .cr3, .crw, .dcr, .dcs, .dng, .erf, .gif, .heic, .j2c, .j2k, .jp2, .jpc, .jpeg, .jpf, .jpg, .jpg2, .jpm, .jpx, .kdc, .mef, .mos, .mrw, .nef, .nrw, .orf, .pef, .png, .ppm, .r3d, .raf, .rw2, .rwl, .sr2, .tga, .tif, .tiff, .wbmp, .web, .webp, .x3f. - Audio/video (media) formats: .aac, .aif, .aiff, .flac, .m4a, .m4r, .mp3, .oga, .ogg, .wav, .wma, .3gp, .3gpp, .3gpp2, .asf, .avi, .dv, .flv, .m2t, .m2ts, .m4v, .mkv, .mov, .mp4, .mpeg, .mpg, .mts, .mxf, .oggtheora, .ogv, .rm, .ts, .vob, .webm, .wmv. - PDF format: .pdf. - MS Office formats: .docx, .pptx, .xlsx. Unsupported formats return an `unsupported_format_error`.

Declaration

public Task<LaunchResultBase> GetMetadataAsyncAsync(FileIdOrUrl fileIdOrUrl = null)

Parameters

Type	Name	Description
FileIdOrUrl	fileIdOrUrl	Identifier of the file to extract metadata from. Callers must set exactly one of the FileIdOrUrl variants. The kind of metadata returned is determined by the file type: image files return EXIF metadata, audio/video files return media metadata, PDFs return PDF metadata, and MS Office documents (docx, pptx, xlsx) return Office metadata. See the route description for the supported formats. Requests against unsupported formats return unsupported_format_error.

Returns

Type	Description
Task<LaunchResultBase>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

GetMetadataAsyncAsync(GetMetadataArgs)

Asynchronous file metadata extraction for supported file formats. The kind of metadata returned depends on the file type: - Image (EXIF) formats: .3fr, .arw, .avif, .bmp, .cr2, .cr3, .crw, .dcr, .dcs, .dng, .erf, .gif, .heic, .j2c, .j2k, .jp2, .jpc, .jpeg, .jpf, .jpg, .jpg2, .jpm, .jpx, .kdc, .mef, .mos, .mrw, .nef, .nrw, .orf, .pef, .png, .ppm, .r3d, .raf, .rw2, .rwl, .sr2, .tga, .tif, .tiff, .wbmp, .web, .webp, .x3f. - Audio/video (media) formats: .aac, .aif, .aiff, .flac, .m4a, .m4r, .mp3, .oga, .ogg, .wav, .wma, .3gp, .3gpp, .3gpp2, .asf, .avi, .dv, .flv, .m2t, .m2ts, .m4v, .mkv, .mov, .mp4, .mpeg, .mpg, .mts, .mxf, .oggtheora, .ogv, .rm, .ts, .vob, .webm, .wmv. - PDF format: .pdf. - MS Office formats: .docx, .pptx, .xlsx. Unsupported formats return an `unsupported_format_error`.

Declaration

public Task<LaunchResultBase> GetMetadataAsyncAsync(GetMetadataArgs getMetadataArgs)

Parameters

Type	Name	Description
GetMetadataArgs	getMetadataArgs	The request parameters

Returns

Type	Description
Task<LaunchResultBase>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

GetMetadataAsyncCheckAsync(PollArg)

Returns the status or result of specified get_metadata_async task.

Declaration

public Task<GetMetadataAsyncCheckResult> GetMetadataAsyncCheckAsync(PollArg pollArg)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters

Returns

Type	Description
Task<GetMetadataAsyncCheckResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

GetMetadataAsyncCheckAsync(string)

Returns the status or result of specified get_metadata_async task.

Declaration

public Task<GetMetadataAsyncCheckResult> GetMetadataAsyncCheckAsync(string asyncJobId)

Parameters

Type	Name	Description
string	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

Returns

Type	Description
Task<GetMetadataAsyncCheckResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

GetOcrAsyncAsync(FileIdOrUrl)

Asynchronous OCR (optical character recognition) text extraction for images and PDFs, including scanned / non-text PDFs. Supported formats: - Image formats: .bmp, .gif, .heic, .jpeg, .jpg, .png, .tif, .tiff, .webp. - PDF format: .pdf. Unsupported formats return an `unsupported_format_error`. For the `url` variant only Dropbox shared links are supported; external URLs return `unsupported_format_error`. Text-based PDFs already carry a text layer, so OCR is not run against them and the result is empty; use `get_text_async` to read the embedded text layer of such a PDF. The result carries the extracted words as plain text, plus the same content as hOCR with per-word coordinates.

Declaration

public Task<LaunchResultBase> GetOcrAsyncAsync(FileIdOrUrl fileIdOrUrl = null)

Parameters

Type	Name	Description
FileIdOrUrl	fileIdOrUrl	Identifier of the file to run OCR on. Callers must set exactly one of the FileIdOrUrl variants. OCR is supported for image files and PDFs, including scanned / non-text PDFs; see the route description for the supported formats. Requests against unsupported formats return unsupported_format_error. NOTE: for the url variant, only Dropbox shared links (www.dropbox.com) are supported. External (non-Dropbox) URLs are not supported and return unsupported_format_error; import the file into Dropbox and reference it by file_id or path instead.

Returns

Type	Description
Task<LaunchResultBase>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

GetOcrAsyncAsync(GetOcrArgs)

Asynchronous OCR (optical character recognition) text extraction for images and PDFs, including scanned / non-text PDFs. Supported formats: - Image formats: .bmp, .gif, .heic, .jpeg, .jpg, .png, .tif, .tiff, .webp. - PDF format: .pdf. Unsupported formats return an `unsupported_format_error`. For the `url` variant only Dropbox shared links are supported; external URLs return `unsupported_format_error`. Text-based PDFs already carry a text layer, so OCR is not run against them and the result is empty; use `get_text_async` to read the embedded text layer of such a PDF. The result carries the extracted words as plain text, plus the same content as hOCR with per-word coordinates.

Declaration

public Task<LaunchResultBase> GetOcrAsyncAsync(GetOcrArgs getOcrArgs)

Parameters

Type	Name	Description
GetOcrArgs	getOcrArgs	The request parameters

Returns

Type	Description
Task<LaunchResultBase>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

GetOcrAsyncCheckAsync(PollArg)

Returns the status or result of specified get_ocr_async task.

Declaration

public Task<GetOcrAsyncCheckResult> GetOcrAsyncCheckAsync(PollArg pollArg)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters

Returns

Type	Description
Task<GetOcrAsyncCheckResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

GetOcrAsyncCheckAsync(string)

Returns the status or result of specified get_ocr_async task.

Declaration

public Task<GetOcrAsyncCheckResult> GetOcrAsyncCheckAsync(string asyncJobId)

Parameters

Type	Name	Description
string	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

Returns

Type	Description
Task<GetOcrAsyncCheckResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

GetTextAsyncAsync(FileIdOrUrl)

Asynchronous plain-text extraction from documents. Supported formats include: - Word processing: .doc, .docx, .docm, .rtf. - Presentations: .ppt, .pptx, .pptm. - Spreadsheets: .xls, .xlsx, .xlsm. - PDF: .pdf. - Dropbox document types: .paper, .papert, .binder, .gdoc, .gsheet, .gslides. - Plain text / subtitles: .txt, .vtt. Unsupported formats return an `unsupported_format_error`. For the `url` variant only Dropbox shared links are supported; external URLs return `unsupported_format_error`.

Declaration

public Task<LaunchResultBase> GetTextAsyncAsync(FileIdOrUrl fileIdOrUrl = null)

Parameters

Type	Name	Description
FileIdOrUrl	fileIdOrUrl	Identifier of the document to extract text from. Callers must set exactly one of the FileIdOrUrl variants. Text extraction is supported for common document formats (Word, PowerPoint, Excel, PDF, RTF, and Dropbox document types); see the route description for the supported formats. Requests against unsupported formats return unsupported_format_error. NOTE: for the url variant, only Dropbox shared links (www.dropbox.com) are supported. External (non-Dropbox) URLs are not supported and return unsupported_format_error; import the file into Dropbox and reference it by file_id or path instead.

Returns

Type	Description
Task<LaunchResultBase>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

GetTextAsyncAsync(GetTextArgs)

Asynchronous plain-text extraction from documents. Supported formats include: - Word processing: .doc, .docx, .docm, .rtf. - Presentations: .ppt, .pptx, .pptm. - Spreadsheets: .xls, .xlsx, .xlsm. - PDF: .pdf. - Dropbox document types: .paper, .papert, .binder, .gdoc, .gsheet, .gslides. - Plain text / subtitles: .txt, .vtt. Unsupported formats return an `unsupported_format_error`. For the `url` variant only Dropbox shared links are supported; external URLs return `unsupported_format_error`.

Declaration

public Task<LaunchResultBase> GetTextAsyncAsync(GetTextArgs getTextArgs)

Parameters

Type	Name	Description
GetTextArgs	getTextArgs	The request parameters

Returns

Type	Description
Task<LaunchResultBase>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

GetTextAsyncCheckAsync(PollArg)

Returns the status or result of specified get_text_async task.

Declaration

public Task<GetTextAsyncCheckResult> GetTextAsyncCheckAsync(PollArg pollArg)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters

Returns

Type	Description
Task<GetTextAsyncCheckResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

GetTextAsyncCheckAsync(string)

Returns the status or result of specified get_text_async task.

Declaration

public Task<GetTextAsyncCheckResult> GetTextAsyncCheckAsync(string asyncJobId)

Parameters

Type	Name	Description
string	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

Returns

Type	Description
Task<GetTextAsyncCheckResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

GetTranscriptAsyncAsync(FileIdOrUrl, TimestampLevel, string, string)

Asynchronous transcript generation for audio and video files. Supported audio formats: .aac, .aif, .aiff, .flac, .m4a, .m4r, .mp3, .oga, .ogg, .wav, .wma. Supported video formats: .3gp, .3gpp, .3gpp2, .asf, .avi, .dv, .flv, .m2t, .m2ts, .m4v, .mkv, .mov, .mp4, .mpeg, .mpg, .mts, .mxf, .oggtheora, .ogv, .rm, .ts, .vob, .webm, .wmv. Unsupported formats return an `unsupported_format_error`. Size limits: the source file must be at most 10 GB and its audio track at most 1 hour in duration. Files exceeding these limits are rejected.

Declaration

public Task<LaunchResultBase> GetTranscriptAsyncAsync(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.

Returns

Type	Description
Task<LaunchResultBase>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

GetTranscriptAsyncAsync(GetTranscriptArgs)

Asynchronous transcript generation for audio and video files. Supported audio formats: .aac, .aif, .aiff, .flac, .m4a, .m4r, .mp3, .oga, .ogg, .wav, .wma. Supported video formats: .3gp, .3gpp, .3gpp2, .asf, .avi, .dv, .flv, .m2t, .m2ts, .m4v, .mkv, .mov, .mp4, .mpeg, .mpg, .mts, .mxf, .oggtheora, .ogv, .rm, .ts, .vob, .webm, .wmv. Unsupported formats return an `unsupported_format_error`. Size limits: the source file must be at most 10 GB and its audio track at most 1 hour in duration. Files exceeding these limits are rejected.

Declaration

public Task<LaunchResultBase> GetTranscriptAsyncAsync(GetTranscriptArgs getTranscriptArgs)

Parameters

Type	Name	Description
GetTranscriptArgs	getTranscriptArgs	The request parameters

Returns

Type	Description
Task<LaunchResultBase>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

GetTranscriptAsyncCheckAsync(PollArg)

Returns the status or result of specified get_transcript_async task.

Declaration

public Task<GetTranscriptAsyncCheckResult> GetTranscriptAsyncCheckAsync(PollArg pollArg)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters

Returns

Type	Description
Task<GetTranscriptAsyncCheckResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

GetTranscriptAsyncCheckAsync(string)

Returns the status or result of specified get_transcript_async task.

Declaration

public Task<GetTranscriptAsyncCheckResult> GetTranscriptAsyncCheckAsync(string asyncJobId)

Parameters

Type	Name	Description
string	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

Returns

Type	Description
Task<GetTranscriptAsyncCheckResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.