-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Loading status checks…
refactor: Update Transcoding service doc (#16)
- Organized content into tabs for improved readability. - Introduced the "error_message" field in the response JSON for transcoding errors. - Included the S3 bucket URL in the input and output url
1 parent
da41a07
commit fc09359
Showing
3 changed files
with
82 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
sidebar_position: 3 | ||
--- | ||
# Get Transcoding Job detail | ||
|
||
To retrieve the details of a transcoding job, make a GET request to the following API endpoint: | ||
|
||
```base | ||
https://app.tpstreams.com/api/v1/<organization_id>/transcoding_jobs/<job_id>/ | ||
``` | ||
|
||
Replace <organization_id> with your organization's unique identifier and <job_id> with the specific job ID you want to retrieve details for. | ||
|
||
#### Sample Response | ||
|
||
```json | ||
{ | ||
"id": "5KQfnXCg8Qh", | ||
"resolutions": [ | ||
"240p", | ||
"480p" | ||
], | ||
"video_duration": 120, | ||
"status": "Completed", | ||
"input_url": "https://example.com/input-video.mp4", | ||
"output_path": "s3://example-bucket/path/?access_key=E8WPS6H1A4OYD3ZNVMR&secret_key=N1dYpS2cTk5AeH6jWf8TgBh9Ji0MkL1N2O3P", | ||
"start_time": "2023-04-20T23:20:06.034924+12:00", | ||
"end_time": "2023-04-20T23:40:06.034924+12:00", | ||
"error_message": null, | ||
} | ||
``` | ||
:::important | ||
In case of transcoding errors, details will be provided in the "error_message" field of the response. | ||
::: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
12 changes: 12 additions & 0 deletions
12
docs/transcoding-service/transcoding-service-introduction.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
sidebar_position: 1 | ||
--- | ||
# Introduction | ||
|
||
Welcome to the Transcoding as a Service documentation! This guide is your gateway to mastering our transcoding service, simplifying the process of converting videos into different resolutions. Transcoding is the key to ensuring your videos play smoothly on various devices and streaming platforms. | ||
|
||
|
||
|
||
Refer the documentation below for more information. | ||
- [Transcode a Video](transcode-a-video) | ||
- [Get Transcoding Job Details](get-transcoding-job-details) |