fastpixapi 1.1.3 → 1.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/fastpix_client/dimensions.rb +3 -3
- data/lib/fastpix_client/errors.rb +1 -1
- data/lib/fastpix_client/in_video_ai_features.rb +8 -8
- data/lib/fastpix_client/input_video.rb +4 -3
- data/lib/fastpix_client/manage_live_stream.rb +13 -12
- data/lib/fastpix_client/manage_videos.rb +21 -23
- data/lib/fastpix_client/metrics.rb +3 -3
- data/lib/fastpix_client/models/components/addtrackrequest.rb +6 -2
- data/lib/fastpix_client/models/components/addtrackrequest.rbi +2 -0
- data/lib/fastpix_client/models/components/addtrackresponse.rb +6 -2
- data/lib/fastpix_client/models/components/addtrackresponse.rbi +2 -0
- data/lib/fastpix_client/models/components/audiotrack.rb +6 -2
- data/lib/fastpix_client/models/components/audiotrack.rbi +2 -0
- data/lib/fastpix_client/models/components/generatetrackresponse.rb +6 -2
- data/lib/fastpix_client/models/components/generatetrackresponse.rbi +2 -0
- data/lib/fastpix_client/models/components/getallmediaresponse.rb +9 -11
- data/lib/fastpix_client/models/components/getallmediaresponse.rbi +2 -0
- data/lib/fastpix_client/models/components/getallmediaresponse_mp4support.rb +32 -12
- data/lib/fastpix_client/models/components/getallmediaresponse_mp4support.rbi +11 -1
- data/lib/fastpix_client/models/components/getallmediaresponse_sourceresolution.rb +2 -0
- data/lib/fastpix_client/models/components/{getmediaresponse.rb → getmediadetailresponse.rb} +14 -16
- data/lib/fastpix_client/models/components/{getmediaresponse.rbi → getmediadetailresponse.rbi} +4 -2
- data/lib/fastpix_client/models/components/{getmediaresponse_maxresolution.rb → getmediadetailresponse_maxresolution.rb} +2 -2
- data/lib/fastpix_client/models/components/getmediadetailresponse_maxresolution.rbi +11 -0
- data/lib/fastpix_client/models/components/{getmediaresponse_mediaquality.rb → getmediadetailresponse_mediaquality.rb} +2 -2
- data/lib/fastpix_client/models/components/getmediadetailresponse_mediaquality.rbi +11 -0
- data/lib/fastpix_client/models/components/getmediadetailresponse_mp4support.rb +48 -0
- data/lib/fastpix_client/models/components/getmediadetailresponse_mp4support.rbi +21 -0
- data/lib/fastpix_client/models/components/{getmediaresponse_sourceresolution.rb → getmediadetailresponse_sourceresolution.rb} +4 -2
- data/lib/fastpix_client/models/components/getmediadetailresponse_sourceresolution.rbi +11 -0
- data/lib/fastpix_client/models/components/{getmediaresponse_status.rb → getmediadetailresponse_status.rb} +2 -2
- data/lib/fastpix_client/models/components/getmediadetailresponse_status.rbi +11 -0
- data/lib/fastpix_client/models/components/{getmediaresponse_track.rb → getmediadetailresponse_track.rb} +1 -1
- data/lib/fastpix_client/models/components/getmediadetailresponse_track.rbi +11 -0
- data/lib/fastpix_client/models/components/live_media_clips.rb +9 -11
- data/lib/fastpix_client/models/components/live_media_clips.rbi +2 -0
- data/lib/fastpix_client/models/components/live_media_clips_mp4support.rb +32 -12
- data/lib/fastpix_client/models/components/live_media_clips_mp4support.rbi +11 -1
- data/lib/fastpix_client/models/components/live_media_clips_sourceresolution.rb +2 -0
- data/lib/fastpix_client/models/components/media.rb +9 -11
- data/lib/fastpix_client/models/components/media.rbi +2 -0
- data/lib/fastpix_client/models/components/media_mp4support.rb +32 -12
- data/lib/fastpix_client/models/components/media_mp4support.rbi +11 -1
- data/lib/fastpix_client/models/components/media_sourceresolution.rb +2 -0
- data/lib/fastpix_client/models/components/sourceaccessmedia.rb +9 -11
- data/lib/fastpix_client/models/components/sourceaccessmedia.rbi +2 -0
- data/lib/fastpix_client/models/components/sourceaccessmedia_mp4support.rb +32 -12
- data/lib/fastpix_client/models/components/sourceaccessmedia_mp4support.rbi +11 -1
- data/lib/fastpix_client/models/components/sourceaccessmedia_sourceresolution.rb +2 -0
- data/lib/fastpix_client/models/components/subtitletrack.rb +6 -2
- data/lib/fastpix_client/models/components/subtitletrack.rbi +2 -0
- data/lib/fastpix_client/models/components/tracksubtitlesgeneraterequest.rb +6 -2
- data/lib/fastpix_client/models/components/tracksubtitlesgeneraterequest.rbi +2 -0
- data/lib/fastpix_client/models/components/update_media.rb +9 -11
- data/lib/fastpix_client/models/components/update_media.rbi +2 -0
- data/lib/fastpix_client/models/components/update_media_maxresolution.rb +0 -1
- data/lib/fastpix_client/models/components/update_media_mp4support.rb +32 -12
- data/lib/fastpix_client/models/components/update_media_mp4support.rbi +11 -1
- data/lib/fastpix_client/models/components/updatetrackrequest.rb +7 -7
- data/lib/fastpix_client/models/components/updatetrackrequest.rbi +2 -2
- data/lib/fastpix_client/models/components/updatetrackresponse.rb +6 -2
- data/lib/fastpix_client/models/components/updatetrackresponse.rbi +2 -0
- data/lib/fastpix_client/models/components/videotrack.rb +6 -2
- data/lib/fastpix_client/models/components/videotrack.rbi +2 -0
- data/lib/fastpix_client/models/components/videotrackforgetall.rb +6 -2
- data/lib/fastpix_client/models/components/videotrackforgetall.rbi +2 -0
- data/lib/fastpix_client/models/components.rb +7 -7
- data/lib/fastpix_client/models/operations/get_media_response.rb +1 -1
- data/lib/fastpix_client/models/operations/get_media_responsebody.rb +2 -2
- data/lib/fastpix_client/playlist.rb +2 -1
- data/lib/fastpix_client/sdkconfiguration.rb +2 -2
- data/lib/fastpix_client/simulcast_stream.rb +3 -3
- data/lib/fastpix_client/start_live_stream.rb +4 -4
- data/lib/fastpix_client/views.rb +3 -3
- metadata +16 -18
- data/lib/fastpix_client/models/components/getmediaresponse_maxresolution.rbi +0 -11
- data/lib/fastpix_client/models/components/getmediaresponse_mediaquality.rbi +0 -11
- data/lib/fastpix_client/models/components/getmediaresponse_mp4support.rb +0 -28
- data/lib/fastpix_client/models/components/getmediaresponse_mp4support.rbi +0 -11
- data/lib/fastpix_client/models/components/getmediaresponse_sourceresolution.rbi +0 -11
- data/lib/fastpix_client/models/components/getmediaresponse_status.rbi +0 -11
- data/lib/fastpix_client/models/components/getmediaresponse_track.rbi +0 -11
- data/test/sdk_examples_test.rb +0 -20
- data/test/test_helper.rb +0 -29
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: bd2162d339bc78c7eca4ab3e7c4aa40556a82c8d2181c290fa37f2febf6a2d8a
|
|
4
|
+
data.tar.gz: 22b7ebf19e385d5d635b647f78ec3090e3612b6f047648194e094224b0baee96
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 4d952510eddef77d7bf6e3266ee2507fdb88e3679574cf7f4d7c954819a3e9538569c31285718493e7a935d2f114157f62c0798fe0722d64e922a04be0cd86d3
|
|
7
|
+
data.tar.gz: a73898288cb56887aa9a95d3082b45712da8836c769c937869c77960f846f1409f66bc3f658a8b5efe8298d84167a4d2d0777cb9f717739a34e6cc77a2051446
|
|
@@ -79,7 +79,7 @@ module FastpixClient
|
|
|
79
79
|
#
|
|
80
80
|
# The dimensions retrieved from this endpoint can be used in conjunction with the <a href="https://fastpix.com/docs/video-data-api/views/list-video-views">list video views</a> and <a href="https://fastpix.com/docs/video-data-api/views/list-by-top-content">list by top content</a> endpoints to filter results based on specific criteria. For example, you can filter views by `browser_name`, `os_name`, `device_type`, and more.
|
|
81
81
|
#
|
|
82
|
-
# Related guides: <a href="https://fastpix.com/docs/
|
|
82
|
+
# Related guides: <a href="https://fastpix.com/docs/video-data/what-video-data-do-we-capture">What Video Data do we capture?</a> , <a href="https://fastpix.com/docs/video-data/pass-custom-metadata-to-metrics">Use passable dimensions</a>
|
|
83
83
|
#
|
|
84
84
|
url, params = @sdk_configuration.get_server_details
|
|
85
85
|
base_url = Utils.template_url(url, params)
|
|
@@ -184,15 +184,15 @@ module FastpixClient
|
|
|
184
184
|
# list_filter_values_for_dimension - List the filter values for a dimension
|
|
185
185
|
# This endpoint returns the filter values associated with a specific dimension, along with the total number of video views for each value. For example, it can list all `browser_name` (dimension) and show how many views occurred for all available browsers like Chrome, Safari (filter values).
|
|
186
186
|
#
|
|
187
|
+
# In order to use the <a href="https://fastpix.com/docs/video-data/use-custom-dimensions">Custom Dimensions</a>, you must enable them in the dashboard under settings option based on the plan you have opted for.
|
|
187
188
|
#
|
|
188
|
-
# In order to use the <a href="https://fastpix.com/docs/working-with-video-data/use-custom-dimensions">Custom Dimensions</a>, you must enable them in the dashboard under settings option based on the plan you have opted for.
|
|
189
189
|
#
|
|
190
190
|
# #### Example
|
|
191
191
|
#
|
|
192
192
|
# A developer wants to know how their video content performs across different browsers. By calling this endpoint for the `device_type` dimension, they can retrieve a breakdown of video views by each device (for example, Desktop, Mobile, Tablet). This data helps the developer understand where optimizations or troubleshooting is necessary.
|
|
193
193
|
#
|
|
194
194
|
#
|
|
195
|
-
# Related guide: <a href="https://fastpix.com/docs/
|
|
195
|
+
# Related guide: <a href="https://fastpix.com/docs/video-data/explore-the-dashboard#filters-and-timeframes">Filters and timespan</a>
|
|
196
196
|
#
|
|
197
197
|
request = Models::Operations::ListFilterValuesForDimensionRequest.new(
|
|
198
198
|
dimensions_id: dimensions_id,
|
|
@@ -89,7 +89,7 @@ module FastpixClient
|
|
|
89
89
|
# * **code:** The error code associated with the specific error.
|
|
90
90
|
#
|
|
91
91
|
#
|
|
92
|
-
# Related guide: <a href="https://fastpix.com/docs/
|
|
92
|
+
# Related guide: <a href="https://fastpix.com/docs/video-data/troubleshoot-playback-errors">Troubleshoot errors</a>
|
|
93
93
|
#
|
|
94
94
|
request = Models::Operations::ListErrorsRequest.new(
|
|
95
95
|
timespan: timespan,
|
|
@@ -102,7 +102,7 @@ module FastpixClient
|
|
|
102
102
|
# 3. Include the `summaryLength` parameter, specify the desired length of the summary in words (for example, 120 words), this determines how concise or detailed the summary will be. If no specific summary length is provided, the default length will be 100 words.
|
|
103
103
|
# 4. The response includes the updated media data and confirmation of the changes applied.
|
|
104
104
|
#
|
|
105
|
-
# You can use the <a href="https://fastpix.com/docs/
|
|
105
|
+
# You can use the <a href="https://fastpix.com/docs/webhooks/in-video-ai-events#videomediaaisummaryready">video.mediaAI.summary.ready</a> webhook event to track and notify about the summary generation.
|
|
106
106
|
#
|
|
107
107
|
#
|
|
108
108
|
#
|
|
@@ -110,7 +110,7 @@ module FastpixClient
|
|
|
110
110
|
#
|
|
111
111
|
# **Use case**: This is particularly useful when a user uploads a video and later chooses to generate a summary without needing to re-upload the video.
|
|
112
112
|
#
|
|
113
|
-
# Related guide: <a href="https://fastpix.com/docs/video-
|
|
113
|
+
# Related guide: <a href="https://fastpix.com/docs/in-video-ai/generate-a-video-summary">Video summary</a>
|
|
114
114
|
#
|
|
115
115
|
request = Models::Operations::UpdateMediaSummaryRequest.new(
|
|
116
116
|
media_id: media_id,
|
|
@@ -233,11 +233,11 @@ module FastpixClient
|
|
|
233
233
|
# 2. Include the `chapters` parameter in the request body to enable.
|
|
234
234
|
# 3. The response contains the updated media data, confirming the changes made.
|
|
235
235
|
#
|
|
236
|
-
# You can use the <a href="https://fastpix.com/docs/ai-events/in-video-ai-events#videomediaaichaptersready">video.mediaAI.chapters.ready</a> webhook event to track and notify about the chapters generation.
|
|
237
236
|
#
|
|
237
|
+
# You can use the <a href="https://fastpix.com/docs/webhooks/in-video-ai-events#videomediaaichaptersready">video.mediaAI.chapters.ready</a> webhook event to track and notify about the chapters generation.
|
|
238
238
|
# **Use case:** This is particularly useful when a user uploads a video and later decides to enable chapters without re-uploading the entire video.
|
|
239
239
|
#
|
|
240
|
-
# Related guide: <a href="https://fastpix.com/docs/video-
|
|
240
|
+
# Related guide: <a href="https://fastpix.com/docs/in-video-ai/generate-video-chapters">Video chapters</a>
|
|
241
241
|
#
|
|
242
242
|
request = Models::Operations::UpdateMediaChaptersRequest.new(
|
|
243
243
|
media_id: media_id,
|
|
@@ -365,11 +365,11 @@ module FastpixClient
|
|
|
365
365
|
# 2. Include the `namedEntities` parameter in the request body to enable.
|
|
366
366
|
# 3. Receive a response containing the updated media data, confirming the changes made.
|
|
367
367
|
#
|
|
368
|
-
# You can use the <a href="https://fastpix.com/docs/
|
|
368
|
+
# You can use the <a href="https://fastpix.com/docs/webhooks/in-video-ai-events#videomediaainamedentitiesready">video.mediaAI.named-entities.ready</a> webhook event to track and notify about the named entities extraction.
|
|
369
369
|
#
|
|
370
370
|
# **Use case:** If a user uploads a video and later decides to enable named entity extraction without re-uploading the entire video.
|
|
371
371
|
#
|
|
372
|
-
# Related guide: <a href="https://fastpix.com/docs/video-
|
|
372
|
+
# Related guide: <a href="https://fastpix.com/docs/in-video-ai/extract-named-entities-from-a-video">Named entities</a>
|
|
373
373
|
#
|
|
374
374
|
request = Models::Operations::UpdateMediaNamedEntitiesRequest.new(
|
|
375
375
|
media_id: media_id,
|
|
@@ -492,11 +492,11 @@ module FastpixClient
|
|
|
492
492
|
# 2. Include the `moderation` object and provide the requried `type` parameter in the request body to specify the media type (for example, video/audio/av).
|
|
493
493
|
# 4. The response contains the updated media data, confirming the changes made.
|
|
494
494
|
#
|
|
495
|
-
# You can use the <a href="https://fastpix.com/docs/
|
|
495
|
+
# You can use the <a href="https://fastpix.com/docs/webhooks/in-video-ai-events#videomediaaimoderationready">video.mediaAI.moderation.ready</a> webhook event to track and notify about the detected moderation results.
|
|
496
496
|
#
|
|
497
497
|
# **Use case:** This is particularly useful when a user uploads a video and later decides to enable moderation detection without the need to re-upload it.
|
|
498
498
|
#
|
|
499
|
-
# Related guide: <a href="https://fastpix.com/docs/video-
|
|
499
|
+
# Related guide: <a href="https://fastpix.com/docs/in-video-ai/detect-nsfw-content-and-profanity">Moderate NSFW & Profanity</a>
|
|
500
500
|
#
|
|
501
501
|
request = Models::Operations::UpdateMediaModerationRequest.new(
|
|
502
502
|
media_id: media_id,
|
|
@@ -127,10 +127,11 @@ module FastpixClient
|
|
|
127
127
|
#
|
|
128
128
|
# 4. Use the id in subsequent API calls, such as checking the status of the media with the <a href="https://fastpix.com/docs/video-on-demand-api/manage-videos/get-media">Get Media by ID</a> endpoint to determine when the media is ready for playback.
|
|
129
129
|
#
|
|
130
|
-
# FastPix uses webhooks to tell your application about things that happen in the background, outside of the API regular request flow. For instance, after the media file is created (but not yet processed or encoded), FastPix sends a `POST` request to your specified webhook URL with the event <a href="https://fastpix.com/docs/
|
|
130
|
+
# FastPix uses webhooks to tell your application about things that happen in the background, outside of the API regular request flow. For instance, after the media file is created (but not yet processed or encoded), FastPix sends a `POST` request to your specified webhook URL with the event <a href="https://fastpix.com/docs/webhooks/media-events#videomediacreated">video.media.created</a>.
|
|
131
131
|
#
|
|
132
132
|
#
|
|
133
|
-
# After processing completes, monitor the events <a href="https://fastpix.com/docs/
|
|
133
|
+
# After processing completes, monitor the events <a href="https://fastpix.com/docs/webhooks/media-events#videomediaready">video.media.ready</a> and <a href="https://fastpix.com/docs/webhooks/media-events#videomediafailed">video.media.failed</a> to track the status of the media file.
|
|
134
|
+
|
|
134
135
|
#
|
|
135
136
|
# Related guide: <a href="https://fastpix.com/docs/upload-videos/upload-videos-from-a-url">Upload videos from URL</a>
|
|
136
137
|
#
|
|
@@ -251,7 +252,7 @@ module FastpixClient
|
|
|
251
252
|
#
|
|
252
253
|
# 2. The response includes an `uploadId` and a signed `url` for direct video file upload.
|
|
253
254
|
#
|
|
254
|
-
# 3. Upload your video file to the provided url by making a PUT request. The API accepts the media file from your device and uploads it to the FastPix platform. (Refer to <a href="https://fastpix.com/docs/upload-videos/upload-videos-from-device#
|
|
255
|
+
# 3. Upload your video file to the provided url by making a PUT request. The API accepts the media file from your device and uploads it to the FastPix platform. (Refer to <a href="https://fastpix.com/docs/upload-videos/upload-videos-from-device#initiate-the-upload-session-web-only">Step 3: Initiate the upload</a> for complete instructions.)
|
|
255
256
|
#
|
|
256
257
|
#
|
|
257
258
|
# 4. Once uploaded, the media undergoes processing and is assigned a unique ID for tracking. Retain this `uploadId` for any future operations related to this upload.
|
|
@@ -216,7 +216,7 @@ module FastpixClient
|
|
|
216
216
|
#
|
|
217
217
|
# Suppose a content creator is hosting a live concert and wants to display the number of live viewers on their dashboard. This endpoint can be queried to show up-to-date viewer statistics.
|
|
218
218
|
#
|
|
219
|
-
#
|
|
219
|
+
# Related guide: <a href="https://fastpix.com/docs/live-streaming/create-and-manage-live-streams#delete-a-stream">Manage streams</a>
|
|
220
220
|
request = Models::Operations::GetLiveStreamViewerCountByIdRequest.new(
|
|
221
221
|
stream_id: stream_id
|
|
222
222
|
)
|
|
@@ -331,8 +331,8 @@ module FastpixClient
|
|
|
331
331
|
#
|
|
332
332
|
# Suppose a news agency is broadcasting a live event and wants to track the configurations set for the live stream while also checking the stream's status.
|
|
333
333
|
#
|
|
334
|
-
#
|
|
335
|
-
#
|
|
334
|
+
# Related guide: <a href="https://fastpix.com/docs/live-streaming/create-and-manage-live-streams#delete-a-stream">Manage streams</a>
|
|
335
|
+
#
|
|
336
336
|
request = Models::Operations::GetLiveStreamByIdRequest.new(
|
|
337
337
|
stream_id: stream_id
|
|
338
338
|
)
|
|
@@ -444,14 +444,14 @@ module FastpixClient
|
|
|
444
444
|
# delete_live_stream - Delete a stream
|
|
445
445
|
# Permanently deletes a specified live stream from the workspace. If the stream is active, the encoder is disconnected and ingestion stops immediately. This action is irreversible, and any future playback attempts fail as a result.
|
|
446
446
|
#
|
|
447
|
-
# Provide the `streamId` in the request to terminate active connections and remove the stream from the workspace. You can further look for <a href="https://fastpix.com/docs/
|
|
447
|
+
# Provide the `streamId` in the request to terminate active connections and remove the stream from the workspace. You can further look for <a href="https://fastpix.com/docs/webhooks/live-events#videolive_streamdeleted">video.live_stream.deleted</a> webhook to notify your system about the status.
|
|
448
448
|
#
|
|
449
449
|
# #### Example
|
|
450
450
|
#
|
|
451
451
|
# For an online concert platform, a trial stream was mistakenly made public. The event manager deletes the stream before the concert begins to avoid confusion among viewers.
|
|
452
452
|
#
|
|
453
453
|
#
|
|
454
|
-
#
|
|
454
|
+
# Related guide: <a href="https://fastpix.com/docs/live-streaming/create-and-manage-live-streams#delete-a-stream">Manage streams</a>
|
|
455
455
|
request = Models::Operations::DeleteLiveStreamRequest.new(
|
|
456
456
|
stream_id: stream_id
|
|
457
457
|
)
|
|
@@ -564,15 +564,16 @@ module FastpixClient
|
|
|
564
564
|
# This endpoint allows you to modify the parameters of an existing live stream, such as its `metadata` (title, description) or the `reconnectWindow`. It’s useful for making changes to a stream that has already been created but not yet ended. After the live stream is disabled, you cannot update a stream.
|
|
565
565
|
#
|
|
566
566
|
#
|
|
567
|
-
#
|
|
568
|
-
#
|
|
567
|
+
#
|
|
568
|
+
# The updated stream parameters and the `streamId` needs to be shared in the request, and FastPix returns the updated stream details. After the update, <a href="https://fastpix.com/docs/webhooks/live-events#videolive_streamupdated">video.live_stream.updated</a> webhook event notifies your system.
|
|
569
569
|
# #### Example
|
|
570
570
|
#
|
|
571
571
|
# A host realizes they need to extend the reconnect window for their live stream in case they lose connection temporarily during the event. Or suppose during a multi-day online conference, the event organizers need to update the stream title to reflect the next day"s session while keeping the same stream ID for continuity.
|
|
572
572
|
#
|
|
573
573
|
#
|
|
574
|
-
#
|
|
575
|
-
#
|
|
574
|
+
# Related guide: <a href="https://fastpix.com/docs/live-streaming/create-and-manage-live-streams#delete-a-stream">Manage streams</a>
|
|
575
|
+
#
|
|
576
|
+
#
|
|
576
577
|
request = Models::Operations::UpdateLiveStreamRequest.new(
|
|
577
578
|
stream_id: stream_id,
|
|
578
579
|
body: body
|
|
@@ -697,7 +698,7 @@ module FastpixClient
|
|
|
697
698
|
#
|
|
698
699
|
# A creator disables a livestream to pause it temporarily. Later, they decide to continue the session. By calling this endpoint with the stream's ID, they can re-enable and restart the same livestream.
|
|
699
700
|
#
|
|
700
|
-
# Related guide <a href="https://fastpix.com/docs/
|
|
701
|
+
# Related guide <a href="https://fastpix.com/docs/live-streaming/create-and-manage-live-streams#enable-a-stream">Manage streams</a>
|
|
701
702
|
request = Models::Operations::EnableLiveStreamRequest.new(
|
|
702
703
|
stream_id: stream_id
|
|
703
704
|
)
|
|
@@ -815,7 +816,7 @@ module FastpixClient
|
|
|
815
816
|
#
|
|
816
817
|
# A speaker finishes their live session and wants to prevent the stream from being mistakenly started again. By calling this endpoint, the stream is transitioned to a `disabled` state, ensuring it's permanently stopped (unless re-enabled on a paid plan).
|
|
817
818
|
#
|
|
818
|
-
#
|
|
819
|
+
#Related guide <a href="https://fastpix.com/docs/live-streaming/create-and-manage-live-streams#enable-a-stream">Manage streams</a>
|
|
819
820
|
request = Models::Operations::DisableLiveStreamRequest.new(
|
|
820
821
|
stream_id: stream_id
|
|
821
822
|
)
|
|
@@ -935,7 +936,7 @@ module FastpixClient
|
|
|
935
936
|
#
|
|
936
937
|
# A virtual event ends, and the system or host needs to close the livestream to prevent further streaming. This endpoint ensures the livestream status is changed from `active` to `idle`, indicating it's officially completed.
|
|
937
938
|
#
|
|
938
|
-
#
|
|
939
|
+
#Related guide <a href="https://fastpix.com/docs/live-streaming/create-and-manage-live-streams#enable-a-stream">Manage streams</a>
|
|
939
940
|
request = Models::Operations::CompleteLiveStreamRequest.new(
|
|
940
941
|
stream_id: stream_id
|
|
941
942
|
)
|
|
@@ -227,7 +227,7 @@ module FastpixClient
|
|
|
227
227
|
# Suppose you’re hosting a live gaming event and want to showcase key moments from the stream — such as top plays or final match highlights. You can use this endpoint to fetch all clips generated from that livestream, display them in your dashboard, or use them for post-event editing and sharing.
|
|
228
228
|
#
|
|
229
229
|
#
|
|
230
|
-
# Related guide: <a href="https://fastpix.com/docs/
|
|
230
|
+
# Related guide: <a href="https://fastpix.com/docs/live-streaming/clip-moments-from-a-live-stream">Instant live clipping</a>
|
|
231
231
|
#
|
|
232
232
|
request = Models::Operations::ListLiveClipsRequest.new(
|
|
233
233
|
livestream_id: livestream_id,
|
|
@@ -481,8 +481,7 @@ module FastpixClient
|
|
|
481
481
|
#
|
|
482
482
|
# 3. The response returns the updated media data, confirming the changes.
|
|
483
483
|
#
|
|
484
|
-
# 4. Monitor the <a href="https://fastpix.com/docs/
|
|
485
|
-
#
|
|
484
|
+
# 4. Monitor the <a href="https://fastpix.com/docs/webhooks/media-events#videomediaupdated">video.media.updated</a> webhook event to track the update status in your system.
|
|
486
485
|
# #### Example
|
|
487
486
|
# If a user uploads a video and later needs to change the title, add a new description, or update tags, you can use this endpoint to update the media metadata without re-uploading the entire video.
|
|
488
487
|
#
|
|
@@ -610,7 +609,7 @@ module FastpixClient
|
|
|
610
609
|
#
|
|
611
610
|
# 2. This action is irreversible. Make sure you no longer need the media before proceeding. Once deleted, the media can’t be retrieved or played back.
|
|
612
611
|
#
|
|
613
|
-
# 3. Monitor the following webhook event: <a href="https://fastpix.com/docs/
|
|
612
|
+
# 3. Monitor the following webhook event: <a href="https://fastpix.com/docs/webhooks/media-events#videomediadeleted">video.media.deleted</a>
|
|
614
613
|
#
|
|
615
614
|
# #### Example
|
|
616
615
|
# A user on a video-sharing platform decides to remove an old video from their profile, or suppose you're running a content moderation system, and one of the videos uploaded by a user violates your platform's policies. Using this endpoint, the media is permanently deleted from your library, ensuring it's no longer accessible or viewable by other users.
|
|
@@ -738,18 +737,17 @@ module FastpixClient
|
|
|
738
737
|
#
|
|
739
738
|
# #### Webhook events
|
|
740
739
|
#
|
|
741
|
-
# 1. After successfully adding a track, your system must receive the webhook event <a href="https://fastpix.com/docs/
|
|
740
|
+
# 1. After successfully adding a track, your system must receive the webhook event <a href="https://fastpix.com/docs/webhooks/transform-media-events#videomediatrackcreated">video.media.track.created</a>.
|
|
742
741
|
#
|
|
743
|
-
# 2. Once the track is processed and ready, you must receive the webhook event <a href="https://fastpix.com/docs/
|
|
742
|
+
# 2. Once the track is processed and ready, you must receive the webhook event <a href="https://fastpix.com/docs/webhooks/transform-media-events#videomediatrackready">video.media.track.ready</a>.
|
|
744
743
|
#
|
|
745
|
-
# 3. Finally, an update event <a href="https://fastpix.com/docs/
|
|
744
|
+
# 3. Finally, an update event <a href="https://fastpix.com/docs/webhooks/media-events#videomediaupdated">video.media.updated</a> must notify your system about the media's updated status.
|
|
746
745
|
#
|
|
747
746
|
#
|
|
748
747
|
# #### Example
|
|
749
748
|
# Suppose you have a video uploaded to the FastPix platform, and you want to add an Italian audio track to it. By calling this API, you can attach an external audio file (https://static.fastpix.com/music-1.mp3) to the media file. Similarly, if you need to add subtitles in different languages, you can specify type: `subtitle` with the corresponding subtitle `url`, `languageCode` and `languageName`.
|
|
750
749
|
#
|
|
751
|
-
# Related guides: <a href="https://fastpix.com/docs/
|
|
752
|
-
#
|
|
750
|
+
# Related guides: <a href="https://fastpix.com/docs/video-on-demand/add-subtitles-to-a-video">Add own subtitle tracks</a>, <a href="https://fastpix.com/docs/video-on-demand/add-audio-to-a-video">Add own audio tracks</a>
|
|
753
751
|
request = Models::Operations::AddMediaTrackRequest.new(
|
|
754
752
|
media_id: media_id,
|
|
755
753
|
body: body
|
|
@@ -873,7 +871,7 @@ module FastpixClient
|
|
|
873
871
|
#
|
|
874
872
|
# #### Webhook Events
|
|
875
873
|
#
|
|
876
|
-
# Once the upload is cancelled, you must receive the webhook event <a href="https://fastpix.com/docs/
|
|
874
|
+
# Once the upload is cancelled, you must receive the webhook event <a href="https://fastpix.com/docs/webhooks/media-events#videomediauploadcancelled">video.media.upload.cancelled</a>.
|
|
877
875
|
#
|
|
878
876
|
# #### Example
|
|
879
877
|
#
|
|
@@ -1003,11 +1001,11 @@ module FastpixClient
|
|
|
1003
1001
|
#
|
|
1004
1002
|
# After updating a track, your system must receive webhook notifications:
|
|
1005
1003
|
#
|
|
1006
|
-
# 1. After successfully updating a track, your system must receive the webhook event <a href="https://fastpix.com/docs/
|
|
1004
|
+
# 1. After successfully updating a track, your system must receive the webhook event <a href="https://fastpix.com/docs/webhooks/transform-media-events#videomediatrackupdated">video.media.track.updated</a>.
|
|
1007
1005
|
#
|
|
1008
|
-
# 2. Once the new track is processed and ready, you must receive the webhook event <a href="https://fastpix.com/docs/
|
|
1006
|
+
# 2. Once the new track is processed and ready, you must receive the webhook event <a href="https://fastpix.com/docs/webhooks/transform-media-events#videomediatrackready">video.media.track.ready</a>.
|
|
1009
1007
|
#
|
|
1010
|
-
# 3. Once the media file is updated with the new track details, a <a href="https://fastpix.com/docs/
|
|
1008
|
+
# 3. Once the media file is updated with the new track details, a <a href="https://fastpix.com/docs/webhooks/media-events#videomediaupdated">video.media.updated</a> event must be triggered.
|
|
1011
1009
|
#
|
|
1012
1010
|
#
|
|
1013
1011
|
# #### Example
|
|
@@ -1016,8 +1014,8 @@ module FastpixClient
|
|
|
1016
1014
|
# - The original track file has errors and needs correction.
|
|
1017
1015
|
# - You want to improve subtitle translations or replace an audio track with a better-quality version.
|
|
1018
1016
|
#
|
|
1019
|
-
# Related guides: <a href="https://fastpix.com/docs/manage-audio-and-subtitle-tracks/add-subtitles-to-a-video">Add own subtitle tracks</a>, <a href="https://fastpix.com/docs/manage-audio-and-subtitle-tracks/add-audio-to-a-video">Add own audio tracks</a>
|
|
1020
1017
|
#
|
|
1018
|
+
# Related guides: <a href="https://fastpix.com/docs/video-on-demand/add-subtitles-to-a-video">Add own subtitle tracks</a>, <a href="https://fastpix.com/docs/video-on-demand/add-audio-to-a-video">Add own audio tracks</a>
|
|
1021
1019
|
request = Models::Operations::UpdateMediaTrackRequest.new(
|
|
1022
1020
|
track_id: track_id,
|
|
1023
1021
|
media_id: media_id,
|
|
@@ -1147,7 +1145,7 @@ module FastpixClient
|
|
|
1147
1145
|
#
|
|
1148
1146
|
# 1. After successfully deleting a track, your system must receive the webhook event **video.media.track.deleted**.
|
|
1149
1147
|
#
|
|
1150
|
-
# 2. Once the media file is updated to reflect the track removal, a <a href="https://fastpix.com/docs/
|
|
1148
|
+
# 2. Once the media file is updated to reflect the track removal, a <a href="https://fastpix.com/docs/webhooks/media-events#videomediaupdated">video.media.updated</a> event must be triggered.
|
|
1151
1149
|
#
|
|
1152
1150
|
#
|
|
1153
1151
|
# #### Example
|
|
@@ -1157,7 +1155,7 @@ module FastpixClient
|
|
|
1157
1155
|
# - The content owner requests the removal of a specific subtitle or audio track.
|
|
1158
1156
|
# - A new version of the track gets uploaded to replace the existing one.
|
|
1159
1157
|
#
|
|
1160
|
-
# Related guides: <a href="https://fastpix.com/docs/
|
|
1158
|
+
# Related guides: <a href="https://fastpix.com/docs/video-on-demand/add-subtitles-to-a-video">Add own subtitle tracks</a>, <a href="https://fastpix.com/docs/video-on-demand/add-audio-to-a-video">Add own audio tracks</a>
|
|
1161
1159
|
#
|
|
1162
1160
|
request = Models::Operations::DeleteMediaTrackRequest.new(
|
|
1163
1161
|
media_id: media_id,
|
|
@@ -1281,11 +1279,11 @@ module FastpixClient
|
|
|
1281
1279
|
#
|
|
1282
1280
|
# #### Webhook Events
|
|
1283
1281
|
#
|
|
1284
|
-
# 1. After the subtitle track is generated and ready, you receive the webhook event <a href="https://fastpix.com/docs/
|
|
1282
|
+
# 1. After the subtitle track is generated and ready, you receive the webhook event <a href="https://fastpix.com/docs/webhooks/transform-media-events#videomediasubtitlegeneratedready">video.media.subtitle.generated</a>.
|
|
1285
1283
|
#
|
|
1286
|
-
# 2. Finally the <a href="https://fastpix.com/docs/
|
|
1284
|
+
# 2. Finally the <a href="https://fastpix.com/docs/webhooks/media-events#videomediaupdated">video.media.updated</a> event notifies your system about the media’s updated status.
|
|
1287
1285
|
#
|
|
1288
|
-
# </br> Related guide: <a href="https://fastpix.com/docs/
|
|
1286
|
+
# </br> Related guide: <a href="https://fastpix.com/docs/video-on-demand/generate-subtitles-automatically">Add auto-generated subtitles</a>
|
|
1289
1287
|
#
|
|
1290
1288
|
request = Models::Operations::GenerateSubtitleTrackRequest.new(
|
|
1291
1289
|
media_id: media_id,
|
|
@@ -1533,7 +1531,7 @@ module FastpixClient
|
|
|
1533
1531
|
# 2. Include the updated `sourceAccess` parameter in the request body.
|
|
1534
1532
|
#
|
|
1535
1533
|
# 3. You receive a response confirming the update to the media’s source access status.
|
|
1536
|
-
# 4. Webhook events: <a href="https://fastpix.com/docs/
|
|
1534
|
+
# 4. Webhook events: <a href="https://fastpix.com/docs/webhooks/transform-media-events#videomediasourceready">video.media.source.ready</a>, <a href="https://fastpix.com/docs/webhooks/transform-media-events#videomediasourcedeleted">video.media.source.deleted</a>
|
|
1537
1535
|
#
|
|
1538
1536
|
request = Models::Operations::UpdatedSourceAccessRequest.new(
|
|
1539
1537
|
media_id: media_id,
|
|
@@ -1671,13 +1669,13 @@ module FastpixClient
|
|
|
1671
1669
|
#
|
|
1672
1670
|
# #### Webhook events
|
|
1673
1671
|
#
|
|
1674
|
-
# - <a href="https://fastpix.com/docs/
|
|
1672
|
+
# - <a href="https://fastpix.com/docs/webhooks/transform-media-events#videomediamp4supportready">video.media.mp4Support.ready</a> – Triggered when the MP4 support setting is successfully updated.
|
|
1675
1673
|
#
|
|
1676
1674
|
# #### Example
|
|
1677
1675
|
# Suppose you have a video uploaded to the FastPix platform, and you want to allow users to download the video in MP4 format. By setting "mp4Support": "capped_4k", the system generates an MP4 rendition of the video up to 4K resolution, making it available for download through the stream URL(`https://stream.fastpix.com/{playbackId}/{capped-4k.mp4 | audio.m4a}`). If you want users to stream only the audio from the media file, you can set "mp4Support": "audioOnly". This provides an audio-only stream URL that allows users to listen to the media without video. By setting "mp4Support": "audioOnly,capped_4k", both options are enabled. Users can download the MP4 video and also stream just the audio version of the media.
|
|
1678
1676
|
#
|
|
1679
1677
|
#
|
|
1680
|
-
# Related guide: <a href="https://fastpix.com/docs/
|
|
1678
|
+
# Related guide: <a href="https://fastpix.com/docs/video-on-demand/enable-mp4-support-for-offline-viewing">Use MP4 support for offline viewing</a>
|
|
1681
1679
|
#
|
|
1682
1680
|
request = Models::Operations::UpdatedMp4SupportRequest.new(
|
|
1683
1681
|
media_id: media_id,
|
|
@@ -2059,7 +2057,7 @@ module FastpixClient
|
|
|
2059
2057
|
#
|
|
2060
2058
|
# Imagine you’re managing a video editing platform where users upload full-length videos and create short clips for social media sharing. To keep track of all clips linked to a particular video, you call this API with the sourceMediaId. The response provides a list of all associated clips, allowing you to manage, edit, or repurpose them as needed.
|
|
2061
2059
|
#
|
|
2062
|
-
# Related guide: <a href="https://fastpix.com/docs/
|
|
2060
|
+
# Related guide: <a href="https://fastpix.com/docs/video-on-demand/clip-and-trim-videos">Create clips from existing media</a>
|
|
2063
2061
|
#
|
|
2064
2062
|
request = Models::Operations::GetMediaClipsRequest.new(
|
|
2065
2063
|
media_id: media_id,
|
|
@@ -108,7 +108,7 @@ module FastpixClient
|
|
|
108
108
|
# * **field:** The grouping field value based on the groupBy parameter.
|
|
109
109
|
#
|
|
110
110
|
#
|
|
111
|
-
# Related guide: <a href="https://fastpix.com/docs/
|
|
111
|
+
# Related guide: <a href="https://fastpix.com/docs/video-data/understand-data-definitions">Understand data definitions</a>
|
|
112
112
|
#
|
|
113
113
|
url, params = @sdk_configuration.get_server_details
|
|
114
114
|
base_url = Utils.template_url(url, params)
|
|
@@ -244,7 +244,7 @@ module FastpixClient
|
|
|
244
244
|
# * **globalValue:** A global metric value that reflects the overall performance of the specified metric across the entire dataset for the given timespan. This value is not affected by specific filters.
|
|
245
245
|
#
|
|
246
246
|
#
|
|
247
|
-
# Related guide: <a href="https://fastpix.com/docs/
|
|
247
|
+
# Related guide: <a href="https://fastpix.com/docs/video-data/understand-data-definitions">Understand data definitions</a>
|
|
248
248
|
#
|
|
249
249
|
request = Models::Operations::ListOverallValuesRequest.new(
|
|
250
250
|
metric_id: metric_id,
|
|
@@ -496,7 +496,7 @@ module FastpixClient
|
|
|
496
496
|
# 3. You Receive a response containing the comparison values for the specified metrics across the selected dimensions.
|
|
497
497
|
#
|
|
498
498
|
#
|
|
499
|
-
#
|
|
499
|
+
# Related guide: <a href="https://fastpix.com/docs/video-data/explore-the-dashboard#compare-metrics">Compare metrics in dashboard</a>
|
|
500
500
|
#
|
|
501
501
|
request = Models::Operations::ListComparisonValuesRequest.new(
|
|
502
502
|
timespan: timespan,
|
|
@@ -20,13 +20,16 @@ module FastpixClient
|
|
|
20
20
|
field :language_code, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('languageCode') } }
|
|
21
21
|
# The full name of the language corresponding to the `languageCode`.
|
|
22
22
|
field :language_name, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('languageName') } }
|
|
23
|
+
# Title of the track.
|
|
24
|
+
field :title, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('title') } }
|
|
23
25
|
|
|
24
|
-
sig { params(url: T.nilable(::String), type: T.nilable(Models::Components::AddTrackRequestType), language_code: T.nilable(::String), language_name: T.nilable(::String)).void }
|
|
25
|
-
def initialize(url: 'https://static.fastpix.com/music-1.mp3', type: Models::Components::AddTrackRequestType::AUDIO, language_code: 'it', language_name: 'Italian')
|
|
26
|
+
sig { params(url: T.nilable(::String), type: T.nilable(Models::Components::AddTrackRequestType), language_code: T.nilable(::String), language_name: T.nilable(::String), title: T.nilable(::String)).void }
|
|
27
|
+
def initialize(url: 'https://static.fastpix.com/music-1.mp3', type: Models::Components::AddTrackRequestType::AUDIO, language_code: 'it', language_name: 'Italian', title: nil)
|
|
26
28
|
@url = url
|
|
27
29
|
@type = type
|
|
28
30
|
@language_code = language_code
|
|
29
31
|
@language_name = language_name
|
|
32
|
+
@title = title
|
|
30
33
|
end
|
|
31
34
|
|
|
32
35
|
sig { params(other: T.untyped).returns(T::Boolean) }
|
|
@@ -36,6 +39,7 @@ module FastpixClient
|
|
|
36
39
|
return false unless @type == other.type
|
|
37
40
|
return false unless @language_code == other.language_code
|
|
38
41
|
return false unless @language_name == other.language_name
|
|
42
|
+
return false unless @title == other.title
|
|
39
43
|
true
|
|
40
44
|
end
|
|
41
45
|
end
|
|
@@ -22,14 +22,17 @@ module FastpixClient
|
|
|
22
22
|
field :language_code, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('languageCode') } }
|
|
23
23
|
# The full name of the language corresponding to the `languageCode`.
|
|
24
24
|
field :language_name, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('languageName') } }
|
|
25
|
+
# Title of the track.
|
|
26
|
+
field :title, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('title') } }
|
|
25
27
|
|
|
26
|
-
sig { params(id: T.nilable(::String), type: T.nilable(Models::Components::AddTrackResponseType), url: T.nilable(::String), language_code: T.nilable(::String), language_name: T.nilable(::String)).void }
|
|
27
|
-
def initialize(id: nil, type: nil, url: nil, language_code: nil, language_name: nil)
|
|
28
|
+
sig { params(id: T.nilable(::String), type: T.nilable(Models::Components::AddTrackResponseType), url: T.nilable(::String), language_code: T.nilable(::String), language_name: T.nilable(::String), title: T.nilable(::String)).void }
|
|
29
|
+
def initialize(id: nil, type: nil, url: nil, language_code: nil, language_name: nil, title: nil)
|
|
28
30
|
@id = id
|
|
29
31
|
@type = type
|
|
30
32
|
@url = url
|
|
31
33
|
@language_code = language_code
|
|
32
34
|
@language_name = language_name
|
|
35
|
+
@title = title
|
|
33
36
|
end
|
|
34
37
|
|
|
35
38
|
sig { params(other: T.untyped).returns(T::Boolean) }
|
|
@@ -40,6 +43,7 @@ module FastpixClient
|
|
|
40
43
|
return false unless @url == other.url
|
|
41
44
|
return false unless @language_code == other.language_code
|
|
42
45
|
return false unless @language_name == other.language_name
|
|
46
|
+
return false unless @title == other.title
|
|
43
47
|
true
|
|
44
48
|
end
|
|
45
49
|
end
|
|
@@ -18,6 +18,8 @@ module FastpixClient
|
|
|
18
18
|
field :type, Crystalline::Nilable.new(Models::Components::AudioTrackType), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('type'), 'decoder': Utils.enum_from_string(Models::Components::AudioTrackType, true) } }
|
|
19
19
|
# Indicates the current state of the track. 'available' means the track has been processed successfully and is ready to be used or played.
|
|
20
20
|
field :status, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('status') } }
|
|
21
|
+
# Title of the track.
|
|
22
|
+
field :title, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('title') } }
|
|
21
23
|
# Name of the language in which the subtitles will be generated.
|
|
22
24
|
#
|
|
23
25
|
field :language_name, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('languageName') } }
|
|
@@ -25,11 +27,12 @@ module FastpixClient
|
|
|
25
27
|
#
|
|
26
28
|
field :language_code, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('languageCode') } }
|
|
27
29
|
|
|
28
|
-
sig { params(id: T.nilable(::String), type: T.nilable(Models::Components::AudioTrackType), status: T.nilable(::String), language_name: T.nilable(::String), language_code: T.nilable(::String)).void }
|
|
29
|
-
def initialize(id: nil, type: nil, status: nil, language_name: nil, language_code: nil)
|
|
30
|
+
sig { params(id: T.nilable(::String), type: T.nilable(Models::Components::AudioTrackType), status: T.nilable(::String), title: T.nilable(::String), language_name: T.nilable(::String), language_code: T.nilable(::String)).void }
|
|
31
|
+
def initialize(id: nil, type: nil, status: nil, title: nil, language_name: nil, language_code: nil)
|
|
30
32
|
@id = id
|
|
31
33
|
@type = type
|
|
32
34
|
@status = status
|
|
35
|
+
@title = title
|
|
33
36
|
@language_name = language_name
|
|
34
37
|
@language_code = language_code
|
|
35
38
|
end
|
|
@@ -40,6 +43,7 @@ module FastpixClient
|
|
|
40
43
|
return false unless @id == other.id
|
|
41
44
|
return false unless @type == other.type
|
|
42
45
|
return false unless @status == other.status
|
|
46
|
+
return false unless @title == other.title
|
|
43
47
|
return false unless @language_name == other.language_name
|
|
44
48
|
return false unless @language_code == other.language_code
|
|
45
49
|
true
|
|
@@ -24,14 +24,17 @@ module FastpixClient
|
|
|
24
24
|
# You can search for videos with specific key value pairs using metadata, when you tag a video in "key" : "value" pairs. Dynamic metadata allows you to define a key that allows any value pair. You can have maximum of 255 characters and upto 10 entries are allowed.
|
|
25
25
|
#
|
|
26
26
|
field :metadata, Crystalline::Nilable.new(Crystalline::Hash.new(Symbol, ::String)), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('metadata') } }
|
|
27
|
+
# Title of the track.
|
|
28
|
+
field :title, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('title') } }
|
|
27
29
|
|
|
28
|
-
sig { params(id: T.nilable(::String), type: T.nilable(Models::Components::GenerateTrackResponseType), language_code: T.nilable(Models::Components::GenerateTrackResponseLanguageCode), language_name: T.nilable(::String), metadata: T.nilable(T::Hash[Symbol, ::String])).void }
|
|
29
|
-
def initialize(id: nil, type: nil, language_code: nil, language_name: nil, metadata: nil)
|
|
30
|
+
sig { params(id: T.nilable(::String), type: T.nilable(Models::Components::GenerateTrackResponseType), language_code: T.nilable(Models::Components::GenerateTrackResponseLanguageCode), language_name: T.nilable(::String), metadata: T.nilable(T::Hash[Symbol, ::String]), title: T.nilable(::String)).void }
|
|
31
|
+
def initialize(id: nil, type: nil, language_code: nil, language_name: nil, metadata: nil, title: nil)
|
|
30
32
|
@id = id
|
|
31
33
|
@type = type
|
|
32
34
|
@language_code = language_code
|
|
33
35
|
@language_name = language_name
|
|
34
36
|
@metadata = metadata
|
|
37
|
+
@title = title
|
|
35
38
|
end
|
|
36
39
|
|
|
37
40
|
sig { params(other: T.untyped).returns(T::Boolean) }
|
|
@@ -42,6 +45,7 @@ module FastpixClient
|
|
|
42
45
|
return false unless @language_code == other.language_code
|
|
43
46
|
return false unless @language_name == other.language_name
|
|
44
47
|
return false unless @metadata == other.metadata
|
|
48
|
+
return false unless @title == other.title
|
|
45
49
|
true
|
|
46
50
|
end
|
|
47
51
|
end
|