fastpixapi 1.1.1 → 1.1.2
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 +4 -4
- data/lib/fastpix_client/drm_configurations.rb +2 -2
- 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 +9 -9
- data/lib/fastpix_client/manage_live_stream.rb +9 -9
- data/lib/fastpix_client/manage_videos.rb +24 -24
- data/lib/fastpix_client/metrics.rb +6 -6
- data/lib/fastpix_client/models/components/addtrackrequest.rb +1 -1
- data/lib/fastpix_client/models/components/createmediarequest.rb +1 -1
- data/lib/fastpix_client/models/components/deletesigningkeyresponse.rb +6 -2
- data/lib/fastpix_client/models/components/deletesigningkeyresponsedata.rb +33 -0
- data/lib/fastpix_client/models/components/pullvideoinput.rb +1 -1
- data/lib/fastpix_client/models/components/views.rb +1 -1
- data/lib/fastpix_client/models/components/watermarkinput.rb +1 -1
- data/lib/fastpix_client/models/components.rb +1 -0
- data/lib/fastpix_client/models/operations/add_media_to_playlist_response.rb +1 -1
- data/lib/fastpix_client/models/operations/add_media_track_response.rb +1 -1
- data/lib/fastpix_client/models/operations/cancel_upload_response.rb +1 -1
- data/lib/fastpix_client/models/operations/change_media_order_in_playlist_response.rb +1 -1
- data/lib/fastpix_client/models/operations/complete_live_stream_response.rb +1 -1
- data/lib/fastpix_client/models/operations/create_a_playlist_response.rb +1 -1
- data/lib/fastpix_client/models/operations/create_media_playback_id_response.rb +1 -1
- data/lib/fastpix_client/models/operations/create_media_response.rb +1 -1
- data/lib/fastpix_client/models/operations/create_new_stream_response.rb +1 -1
- data/lib/fastpix_client/models/operations/create_playbackid_of_stream_response.rb +1 -1
- data/lib/fastpix_client/models/operations/create_signing_key_response.rb +1 -1
- data/lib/fastpix_client/models/operations/create_simulcast_of_stream_response.rb +1 -1
- data/lib/fastpix_client/models/operations/delete_a_playlist_response.rb +1 -1
- data/lib/fastpix_client/models/operations/delete_live_stream_response.rb +1 -1
- data/lib/fastpix_client/models/operations/delete_media_from_playlist_response.rb +1 -1
- data/lib/fastpix_client/models/operations/delete_media_playback_id_response.rb +1 -1
- data/lib/fastpix_client/models/operations/delete_media_response.rb +1 -1
- data/lib/fastpix_client/models/operations/delete_media_track_response.rb +1 -1
- data/lib/fastpix_client/models/operations/delete_playbackid_of_stream_response.rb +1 -1
- data/lib/fastpix_client/models/operations/delete_signing_key_response.rb +1 -1
- data/lib/fastpix_client/models/operations/delete_simulcast_of_stream_response.rb +1 -1
- data/lib/fastpix_client/models/operations/direct_upload_video_media_request.rb +1 -1
- data/lib/fastpix_client/models/operations/direct_upload_video_media_response.rb +1 -1
- data/lib/fastpix_client/models/operations/disable_live_stream_response.rb +1 -1
- data/lib/fastpix_client/models/operations/enable_live_stream_response.rb +1 -1
- data/lib/fastpix_client/models/operations/generate_subtitle_track_response.rb +1 -1
- data/lib/fastpix_client/models/operations/get_all_playlists_response.rb +1 -1
- data/lib/fastpix_client/models/operations/get_all_streams_response.rb +1 -1
- data/lib/fastpix_client/models/operations/get_live_stream_by_id_response.rb +1 -1
- data/lib/fastpix_client/models/operations/get_live_stream_playback_id_response.rb +1 -1
- data/lib/fastpix_client/models/operations/get_live_stream_viewer_count_by_id_response.rb +1 -1
- data/lib/fastpix_client/models/operations/get_media_clips_response.rb +1 -1
- data/lib/fastpix_client/models/operations/get_media_response.rb +1 -1
- data/lib/fastpix_client/models/operations/get_media_summary_response.rb +1 -1
- data/lib/fastpix_client/models/operations/get_playback_id_response.rb +1 -1
- data/lib/fastpix_client/models/operations/get_playlist_by_id_response.rb +1 -1
- data/lib/fastpix_client/models/operations/get_signing_key_by_id_response.rb +1 -1
- data/lib/fastpix_client/models/operations/get_specific_simulcast_of_stream_response.rb +1 -1
- data/lib/fastpix_client/models/operations/get_timeseries_data_response.rb +1 -1
- data/lib/fastpix_client/models/operations/get_video_view_details_response.rb +1 -1
- data/lib/fastpix_client/models/operations/getdrmconfiguration_response.rb +1 -1
- data/lib/fastpix_client/models/operations/getdrmconfigurationbyid_response.rb +1 -1
- data/lib/fastpix_client/models/operations/list_breakdown_values_response.rb +1 -1
- data/lib/fastpix_client/models/operations/list_by_top_content_response.rb +1 -1
- data/lib/fastpix_client/models/operations/list_comparison_values_response.rb +1 -1
- data/lib/fastpix_client/models/operations/list_dimensions_response.rb +1 -1
- data/lib/fastpix_client/models/operations/list_errors_response.rb +1 -1
- data/lib/fastpix_client/models/operations/list_filter_values_for_dimension_response.rb +1 -1
- data/lib/fastpix_client/models/operations/list_live_clips_response.rb +1 -1
- data/lib/fastpix_client/models/operations/list_media_response.rb +1 -1
- data/lib/fastpix_client/models/operations/list_overall_values_response.rb +1 -1
- data/lib/fastpix_client/models/operations/list_playback_ids_response.rb +1 -1
- data/lib/fastpix_client/models/operations/list_signing_keys_response.rb +1 -1
- data/lib/fastpix_client/models/operations/list_uploads_response.rb +1 -1
- data/lib/fastpix_client/models/operations/list_video_views_response.rb +1 -1
- data/lib/fastpix_client/models/operations/push_media_settings.rb +1 -1
- data/lib/fastpix_client/models/operations/retrievemediainputinfo_response.rb +1 -1
- data/lib/fastpix_client/models/operations/update_a_playlist_response.rb +1 -1
- data/lib/fastpix_client/models/operations/update_domain_restrictions_response.rb +1 -1
- data/lib/fastpix_client/models/operations/update_live_stream_response.rb +1 -1
- data/lib/fastpix_client/models/operations/update_media_chapters_response.rb +1 -1
- data/lib/fastpix_client/models/operations/update_media_moderation_response.rb +1 -1
- data/lib/fastpix_client/models/operations/update_media_named_entities_response.rb +1 -1
- data/lib/fastpix_client/models/operations/update_media_summary_response.rb +1 -1
- data/lib/fastpix_client/models/operations/update_media_track_response.rb +1 -1
- data/lib/fastpix_client/models/operations/update_specific_simulcast_of_stream_response.rb +1 -1
- data/lib/fastpix_client/models/operations/update_user_agent_restrictions_response.rb +1 -1
- data/lib/fastpix_client/models/operations/updated_media_response.rb +1 -1
- data/lib/fastpix_client/models/operations/updated_mp4support_response.rb +1 -1
- data/lib/fastpix_client/models/operations/updated_source_access_response.rb +1 -1
- data/lib/fastpix_client/playback.rb +1 -1
- data/lib/fastpix_client/playlist.rb +1 -1
- data/lib/fastpix_client/sdkconfiguration.rb +3 -3
- data/lib/fastpix_client/signing_keys.rb +3 -3
- data/lib/fastpix_client/simulcast_stream.rb +4 -4
- data/lib/fastpix_client/start_live_stream.rb +3 -3
- data/lib/fastpix_client/utils/url.rb +5 -0
- data/lib/fastpix_client/views.rb +5 -5
- metadata +19 -4
|
@@ -20,7 +20,7 @@ module FastpixClient
|
|
|
20
20
|
field :raw_response, ::Faraday::Response
|
|
21
21
|
# Successfully retrieved playback IDs and their restrictions
|
|
22
22
|
field :object, Crystalline::Nilable.new(Models::Operations::ListPlaybackIdsResponseBody)
|
|
23
|
-
# See the range of possible <a href="https://
|
|
23
|
+
# See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
|
|
24
24
|
field :default_error, Crystalline::Nilable.new(Models::Components::DefaultError)
|
|
25
25
|
|
|
26
26
|
sig { params(content_type: ::String, status_code: ::Integer, raw_response: ::Faraday::Response, object: T.nilable(Models::Operations::ListPlaybackIdsResponseBody), default_error: T.nilable(Models::Components::DefaultError)).void }
|
|
@@ -20,7 +20,7 @@ module FastpixClient
|
|
|
20
20
|
field :raw_response, ::Faraday::Response
|
|
21
21
|
# successfully fetched all signing keys
|
|
22
22
|
field :get_all_signing_keys_response, Crystalline::Nilable.new(Models::Components::GetAllSigningKeysResponse)
|
|
23
|
-
# See the range of possible <a href="https://
|
|
23
|
+
# See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
|
|
24
24
|
field :default_error, Crystalline::Nilable.new(Models::Components::DefaultError)
|
|
25
25
|
|
|
26
26
|
sig { params(content_type: ::String, status_code: ::Integer, raw_response: ::Faraday::Response, get_all_signing_keys_response: T.nilable(Models::Components::GetAllSigningKeysResponse), default_error: T.nilable(Models::Components::DefaultError)).void }
|
|
@@ -20,7 +20,7 @@ module FastpixClient
|
|
|
20
20
|
field :raw_response, ::Faraday::Response
|
|
21
21
|
# List of video media
|
|
22
22
|
field :object, Crystalline::Nilable.new(Models::Operations::ListUploadsResponseBody)
|
|
23
|
-
# See the range of possible <a href="https://
|
|
23
|
+
# See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
|
|
24
24
|
field :default_error, Crystalline::Nilable.new(Models::Components::DefaultError)
|
|
25
25
|
|
|
26
26
|
sig { params(content_type: ::String, status_code: ::Integer, raw_response: ::Faraday::Response, object: T.nilable(Models::Operations::ListUploadsResponseBody), default_error: T.nilable(Models::Components::DefaultError)).void }
|
|
@@ -20,7 +20,7 @@ module FastpixClient
|
|
|
20
20
|
field :raw_response, ::Faraday::Response
|
|
21
21
|
# Get the list of Views
|
|
22
22
|
field :object, Crystalline::Nilable.new(Models::Operations::ListVideoViewsResponseBody)
|
|
23
|
-
# See the range of possible <a href="https://
|
|
23
|
+
# See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
|
|
24
24
|
field :default_error, Crystalline::Nilable.new(Models::Components::DefaultError)
|
|
25
25
|
|
|
26
26
|
sig { params(content_type: ::String, status_code: ::Integer, raw_response: ::Faraday::Response, object: T.nilable(Models::Operations::ListVideoViewsResponseBody), default_error: T.nilable(Models::Components::DefaultError)).void }
|
|
@@ -10,7 +10,7 @@ module FastpixClient
|
|
|
10
10
|
# Configuration settings for uploading and processing media on the FastPix platform.
|
|
11
11
|
# These settings define how the uploaded video is handled, including access control, resolution, DRM, and optional metadata.
|
|
12
12
|
# For a complete explanation of how media uploads and processing work, refer to the
|
|
13
|
-
# <a href="https://
|
|
13
|
+
# <a href="https://fastpix.com/docs/get-started/overview" target="_blank">FastPix Video on Demand Overview</a>.
|
|
14
14
|
#
|
|
15
15
|
class PushMediaSettings
|
|
16
16
|
extend T::Sig
|
|
@@ -20,7 +20,7 @@ module FastpixClient
|
|
|
20
20
|
field :raw_response, ::Faraday::Response
|
|
21
21
|
# Get video media input information
|
|
22
22
|
field :object, Crystalline::Nilable.new(Models::Operations::RetrieveMediaInputInfoResponseBody)
|
|
23
|
-
# See the range of possible <a href="https://
|
|
23
|
+
# See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
|
|
24
24
|
field :default_error, Crystalline::Nilable.new(Models::Components::DefaultError)
|
|
25
25
|
|
|
26
26
|
sig { params(content_type: ::String, status_code: ::Integer, raw_response: ::Faraday::Response, object: T.nilable(Models::Operations::RetrieveMediaInputInfoResponseBody), default_error: T.nilable(Models::Components::DefaultError)).void }
|
|
@@ -20,7 +20,7 @@ module FastpixClient
|
|
|
20
20
|
field :raw_response, ::Faraday::Response
|
|
21
21
|
# Playlist updated successfully
|
|
22
22
|
field :playlist_created_response, Crystalline::Nilable.new(Models::Components::PlaylistCreatedResponse)
|
|
23
|
-
# See the range of possible <a href="https://
|
|
23
|
+
# See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
|
|
24
24
|
field :default_error, Crystalline::Nilable.new(Models::Components::DefaultError)
|
|
25
25
|
|
|
26
26
|
sig { params(content_type: ::String, status_code: ::Integer, raw_response: ::Faraday::Response, playlist_created_response: T.nilable(Models::Components::PlaylistCreatedResponse), default_error: T.nilable(Models::Components::DefaultError)).void }
|
|
@@ -20,7 +20,7 @@ module FastpixClient
|
|
|
20
20
|
field :raw_response, ::Faraday::Response
|
|
21
21
|
# Successfully updated domain restrictions
|
|
22
22
|
field :object, Crystalline::Nilable.new(Models::Operations::UpdateDomainRestrictionsResponseBody)
|
|
23
|
-
# See the range of possible <a href="https://
|
|
23
|
+
# See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
|
|
24
24
|
field :default_error, Crystalline::Nilable.new(Models::Components::DefaultError)
|
|
25
25
|
|
|
26
26
|
sig { params(content_type: ::String, status_code: ::Integer, raw_response: ::Faraday::Response, object: T.nilable(Models::Operations::UpdateDomainRestrictionsResponseBody), default_error: T.nilable(Models::Components::DefaultError)).void }
|
|
@@ -20,7 +20,7 @@ module FastpixClient
|
|
|
20
20
|
field :raw_response, ::Faraday::Response
|
|
21
21
|
# Stream details updated successfully
|
|
22
22
|
field :patch_response_dto, Crystalline::Nilable.new(Models::Components::PatchResponseDTO)
|
|
23
|
-
# See the range of possible <a href="https://
|
|
23
|
+
# See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
|
|
24
24
|
field :default_error, Crystalline::Nilable.new(Models::Components::DefaultError)
|
|
25
25
|
|
|
26
26
|
sig { params(content_type: ::String, status_code: ::Integer, raw_response: ::Faraday::Response, patch_response_dto: T.nilable(Models::Components::PatchResponseDTO), default_error: T.nilable(Models::Components::DefaultError)).void }
|
|
@@ -20,7 +20,7 @@ module FastpixClient
|
|
|
20
20
|
field :raw_response, ::Faraday::Response
|
|
21
21
|
# Media details updated successfully with the chapters feature enabled or disabled
|
|
22
22
|
field :object, Crystalline::Nilable.new(Models::Operations::UpdateMediaChaptersResponseBody)
|
|
23
|
-
# See the range of possible <a href="https://
|
|
23
|
+
# See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
|
|
24
24
|
field :default_error, Crystalline::Nilable.new(Models::Components::DefaultError)
|
|
25
25
|
|
|
26
26
|
sig { params(content_type: ::String, status_code: ::Integer, raw_response: ::Faraday::Response, object: T.nilable(Models::Operations::UpdateMediaChaptersResponseBody), default_error: T.nilable(Models::Components::DefaultError)).void }
|
|
@@ -20,7 +20,7 @@ module FastpixClient
|
|
|
20
20
|
field :raw_response, ::Faraday::Response
|
|
21
21
|
# Media details updated successfully with the named entity extraction feature enabled or disabled
|
|
22
22
|
field :object, Crystalline::Nilable.new(Models::Operations::UpdateMediaModerationResponseBody)
|
|
23
|
-
# See the range of possible <a href="https://
|
|
23
|
+
# See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
|
|
24
24
|
field :default_error, Crystalline::Nilable.new(Models::Components::DefaultError)
|
|
25
25
|
|
|
26
26
|
sig { params(content_type: ::String, status_code: ::Integer, raw_response: ::Faraday::Response, object: T.nilable(Models::Operations::UpdateMediaModerationResponseBody), default_error: T.nilable(Models::Components::DefaultError)).void }
|
|
@@ -20,7 +20,7 @@ module FastpixClient
|
|
|
20
20
|
field :raw_response, ::Faraday::Response
|
|
21
21
|
# Media details updated successfully with the named entity extraction feature enabled or disabled
|
|
22
22
|
field :object, Crystalline::Nilable.new(Models::Operations::UpdateMediaNamedEntitiesResponseBody)
|
|
23
|
-
# See the range of possible <a href="https://
|
|
23
|
+
# See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
|
|
24
24
|
field :default_error, Crystalline::Nilable.new(Models::Components::DefaultError)
|
|
25
25
|
|
|
26
26
|
sig { params(content_type: ::String, status_code: ::Integer, raw_response: ::Faraday::Response, object: T.nilable(Models::Operations::UpdateMediaNamedEntitiesResponseBody), default_error: T.nilable(Models::Components::DefaultError)).void }
|
|
@@ -20,7 +20,7 @@ module FastpixClient
|
|
|
20
20
|
field :raw_response, ::Faraday::Response
|
|
21
21
|
# Media details updated successfully with the generated summary
|
|
22
22
|
field :object, Crystalline::Nilable.new(Models::Operations::UpdateMediaSummaryResponseBody)
|
|
23
|
-
# See the range of possible <a href="https://
|
|
23
|
+
# See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
|
|
24
24
|
field :default_error, Crystalline::Nilable.new(Models::Components::DefaultError)
|
|
25
25
|
|
|
26
26
|
sig { params(content_type: ::String, status_code: ::Integer, raw_response: ::Faraday::Response, object: T.nilable(Models::Operations::UpdateMediaSummaryResponseBody), default_error: T.nilable(Models::Components::DefaultError)).void }
|
|
@@ -20,7 +20,7 @@ module FastpixClient
|
|
|
20
20
|
field :raw_response, ::Faraday::Response
|
|
21
21
|
# Media details updated successfully
|
|
22
22
|
field :object, Crystalline::Nilable.new(Models::Operations::UpdateMediaTrackResponseBody)
|
|
23
|
-
# See the range of possible <a href="https://
|
|
23
|
+
# See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
|
|
24
24
|
field :default_error, Crystalline::Nilable.new(Models::Components::DefaultError)
|
|
25
25
|
|
|
26
26
|
sig { params(content_type: ::String, status_code: ::Integer, raw_response: ::Faraday::Response, object: T.nilable(Models::Operations::UpdateMediaTrackResponseBody), default_error: T.nilable(Models::Components::DefaultError)).void }
|
|
@@ -20,7 +20,7 @@ module FastpixClient
|
|
|
20
20
|
field :raw_response, ::Faraday::Response
|
|
21
21
|
# Stream's simulcast details fetched successfully
|
|
22
22
|
field :simulcast_update_response, Crystalline::Nilable.new(Models::Components::SimulcastUpdateResponse)
|
|
23
|
-
# See the range of possible <a href="https://
|
|
23
|
+
# See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
|
|
24
24
|
field :default_error, Crystalline::Nilable.new(Models::Components::DefaultError)
|
|
25
25
|
|
|
26
26
|
sig { params(content_type: ::String, status_code: ::Integer, raw_response: ::Faraday::Response, simulcast_update_response: T.nilable(Models::Components::SimulcastUpdateResponse), default_error: T.nilable(Models::Components::DefaultError)).void }
|
|
@@ -20,7 +20,7 @@ module FastpixClient
|
|
|
20
20
|
field :raw_response, ::Faraday::Response
|
|
21
21
|
# Successfully updated user-agent restrictions
|
|
22
22
|
field :object, Crystalline::Nilable.new(Models::Operations::UpdateUserAgentRestrictionsResponseBody)
|
|
23
|
-
# See the range of possible <a href="https://
|
|
23
|
+
# See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
|
|
24
24
|
field :default_error, Crystalline::Nilable.new(Models::Components::DefaultError)
|
|
25
25
|
|
|
26
26
|
sig { params(content_type: ::String, status_code: ::Integer, raw_response: ::Faraday::Response, object: T.nilable(Models::Operations::UpdateUserAgentRestrictionsResponseBody), default_error: T.nilable(Models::Components::DefaultError)).void }
|
|
@@ -20,7 +20,7 @@ module FastpixClient
|
|
|
20
20
|
field :raw_response, ::Faraday::Response
|
|
21
21
|
# Media details updated successfully
|
|
22
22
|
field :object, Crystalline::Nilable.new(Models::Operations::UpdatedMediaResponseBody)
|
|
23
|
-
# See the range of possible <a href="https://
|
|
23
|
+
# See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
|
|
24
24
|
field :default_error, Crystalline::Nilable.new(Models::Components::DefaultError)
|
|
25
25
|
|
|
26
26
|
sig { params(content_type: ::String, status_code: ::Integer, raw_response: ::Faraday::Response, object: T.nilable(Models::Operations::UpdatedMediaResponseBody), default_error: T.nilable(Models::Components::DefaultError)).void }
|
|
@@ -20,7 +20,7 @@ module FastpixClient
|
|
|
20
20
|
field :raw_response, ::Faraday::Response
|
|
21
21
|
# Media details updated successfully
|
|
22
22
|
field :object, Crystalline::Nilable.new(Models::Operations::UpdatedMp4SupportResponseBody)
|
|
23
|
-
# See the range of possible <a href="https://
|
|
23
|
+
# See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
|
|
24
24
|
field :default_error, Crystalline::Nilable.new(Models::Components::DefaultError)
|
|
25
25
|
|
|
26
26
|
sig { params(content_type: ::String, status_code: ::Integer, raw_response: ::Faraday::Response, object: T.nilable(Models::Operations::UpdatedMp4SupportResponseBody), default_error: T.nilable(Models::Components::DefaultError)).void }
|
|
@@ -20,7 +20,7 @@ module FastpixClient
|
|
|
20
20
|
field :raw_response, ::Faraday::Response
|
|
21
21
|
# Media details updated successfully
|
|
22
22
|
field :object, Crystalline::Nilable.new(Models::Operations::UpdatedSourceAccessResponseBody)
|
|
23
|
-
# See the range of possible <a href="https://
|
|
23
|
+
# See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
|
|
24
24
|
field :default_error, Crystalline::Nilable.new(Models::Components::DefaultError)
|
|
25
25
|
|
|
26
26
|
sig { params(content_type: ::String, status_code: ::Integer, raw_response: ::Faraday::Response, object: T.nilable(Models::Operations::UpdatedSourceAccessResponseBody), default_error: T.nilable(Models::Components::DefaultError)).void }
|
|
@@ -42,7 +42,7 @@ module FastpixClient
|
|
|
42
42
|
sig { params(body: Models::Operations::CreateMediaPlaybackIdRequestBody, media_id: ::String, timeout_ms: T.nilable(Integer)).returns(Models::Operations::CreateMediaPlaybackIdResponse) }
|
|
43
43
|
def create_media_playback_id(body:, media_id:, timeout_ms: nil)
|
|
44
44
|
# create_media_playback_id - Create a playback ID
|
|
45
|
-
# You can create a new playback ID for a specific media asset. If you have already retrieved an existing `playbackId` using the <a href="https://
|
|
45
|
+
# You can create a new playback ID for a specific media asset. If you have already retrieved an existing `playbackId` using the <a href="https://fastpix.com/docs/video-on-demand-api/manage-videos/get-media">Get Media by ID</a> endpoint for a media asset, you can use this endpoint to generate a new playback ID with a specified access policy.
|
|
46
46
|
#
|
|
47
47
|
#
|
|
48
48
|
#
|
|
@@ -47,7 +47,7 @@ module FastpixClient
|
|
|
47
47
|
# - **Manual:** Creates an empty playlist without any initial media items. Use this mode for manual curation, where you add items later in a user-defined sequence.
|
|
48
48
|
# - **Smart:** Auto-populates the playlist at creation time based on the filter criteria (for example, a video creation date range) that you provide in the request.
|
|
49
49
|
#
|
|
50
|
-
# For more details, see <a href="https://
|
|
50
|
+
# For more details, see <a href="https://fastpix.com/docs/playback-and-delivery/create-and-manage-playlists">Create and manage playlist</a>.
|
|
51
51
|
#
|
|
52
52
|
# #### How it works
|
|
53
53
|
#
|
|
@@ -16,7 +16,7 @@ module FastpixClient
|
|
|
16
16
|
# Contains the list of servers available to the SDK
|
|
17
17
|
SERVERS = T.let(
|
|
18
18
|
[
|
|
19
|
-
'https://api.fastpix.
|
|
19
|
+
'https://api.fastpix.com/v1/', # 1 - FastPix Video APIs
|
|
20
20
|
].freeze,
|
|
21
21
|
T::Array[String]
|
|
22
22
|
)
|
|
@@ -91,9 +91,9 @@ module FastpixClient
|
|
|
91
91
|
end
|
|
92
92
|
@language = 'ruby'
|
|
93
93
|
@openapi_doc_version = '1.0.0'
|
|
94
|
-
@sdk_version = '1.1.
|
|
94
|
+
@sdk_version = '1.1.2'
|
|
95
95
|
@gen_version = '2.801.0'
|
|
96
|
-
@user_agent = 'fastpixapi-ruby 1.1.
|
|
96
|
+
@user_agent = 'fastpixapi-ruby 1.1.2'
|
|
97
97
|
end
|
|
98
98
|
|
|
99
99
|
sig { returns([String, T::Hash[Symbol, String]]) }
|
|
@@ -68,7 +68,7 @@ module FastpixClient
|
|
|
68
68
|
#
|
|
69
69
|
#
|
|
70
70
|
# **Detailed example:** You are building a video-on-demand platform that restricts access based on user subscriptions. To ensure only subscribed users can stream content, you generate a signing key using this API. Each time a user logs in, you create a JWT signed with the private key. When the user attempts to play a video, FastPix uses the public key to verify the token and confirms that the user is authorized.<br/>
|
|
71
|
-
# Related guide: <a href="https://
|
|
71
|
+
# Related guide: <a href="https://fastpix.com/docs/video-security/secure-media-access-with-jwts">Create and use signing keys</a>
|
|
72
72
|
url, params = @sdk_configuration.get_server_details
|
|
73
73
|
base_url = Utils.template_url(url, params)
|
|
74
74
|
url = "#{base_url}/iam/signing-keys"
|
|
@@ -502,7 +502,7 @@ module FastpixClient
|
|
|
502
502
|
# {
|
|
503
503
|
# "kid": "359302ee-2446-4afe-9348-8b4656b9ddb1",
|
|
504
504
|
# "aud": "media:6cee6f85-9334-4a51-9ce3-e0241d94ceef",
|
|
505
|
-
# "iss": "fastpix.
|
|
505
|
+
# "iss": "fastpix.com",
|
|
506
506
|
# "sub": "",
|
|
507
507
|
# "iat": 1706703204,
|
|
508
508
|
# "exp": 1735626783
|
|
@@ -514,7 +514,7 @@ module FastpixClient
|
|
|
514
514
|
#
|
|
515
515
|
# * **kid:** The key ID of the signing key.
|
|
516
516
|
# * **aud:** The audience for which the token is intended, enter the playbackId here.
|
|
517
|
-
# * **iss:** The issuer of the token (for example, "fastpix.
|
|
517
|
+
# * **iss:** The issuer of the token (for example, "fastpix.com ").
|
|
518
518
|
# * **sub:** The subject of the token, typically representing the user or entity the token is issued for. In this case, use the workspaceId fetched from the "Get Signing Key by ID" endpoint.
|
|
519
519
|
# * **groups:** An array of groups the subject belongs to (for example, ["user"]).
|
|
520
520
|
# * **iat:** The issued-at timestamp, indicating when the token was created.
|
|
@@ -47,12 +47,12 @@ module FastpixClient
|
|
|
47
47
|
#
|
|
48
48
|
# 1. Change to: When you call this endpoint, provide the parent `streamId` along with the simulcast target details (such as platform and credentials). The API returns a unique `simulcastId`, which you can use to manage the simulcast later.
|
|
49
49
|
#
|
|
50
|
-
# 2. To notify your application about the status of simulcast related events check for the <a href="https://
|
|
50
|
+
# 2. To notify your application about the status of simulcast related events check for the <a href="https://fastpix.com/docs/webhooks/webhook-event-reference#simulcast-target-events">webhooks for simulcast</a> target events.
|
|
51
51
|
#
|
|
52
52
|
# #### Example
|
|
53
53
|
# An event manager sets up a live stream for a virtual conference and wants to simulcast the stream on YouTube and Facebook Live. They first create the primary live stream in FastPix, ensuring it's in the idle state. Then, they use the API to create a simulcast target for YouTube.
|
|
54
54
|
#
|
|
55
|
-
# Related guide: <a href="https://
|
|
55
|
+
# Related guide: <a href="https://fastpix.com/docs/edit-and-transform-live-stream/simulcast-to-multiple-platforms">Simulcast to 3rd party platforms</a>
|
|
56
56
|
request = Models::Operations::CreateSimulcastOfStreamRequest.new(
|
|
57
57
|
stream_id: stream_id,
|
|
58
58
|
body: body
|
|
@@ -197,7 +197,7 @@ module FastpixClient
|
|
|
197
197
|
# delete_simulcast_of_stream - Delete a simulcast
|
|
198
198
|
# Deletes a simulcast using its unique simulcastId, which you received during the simulcast creation process. Deleting a simulcast stops the broadcast to the associated platform, while the parent stream continues if it’s live. This action can’t be undone, and you must create a new simulcast to resume streaming to the same platform.
|
|
199
199
|
#
|
|
200
|
-
# Webhook event: <a href="https://
|
|
200
|
+
# Webhook event: <a href="https://fastpix.com/docs/live-stream-events/live-events#videolive_streamsimulcast_targetdeleted">video.live_stream.simulcast_target.deleted</a>
|
|
201
201
|
#
|
|
202
202
|
#
|
|
203
203
|
# #### Example
|
|
@@ -468,7 +468,7 @@ module FastpixClient
|
|
|
468
468
|
# update_specific_simulcast_of_stream - Update a simulcast
|
|
469
469
|
# Updates the status of a specific simulcast linked to a parent live stream. You can enable or disable the simulcast at any time while the parent stream is active or idle. After the live stream is disabled, the simulcast can no longer be modified.
|
|
470
470
|
#
|
|
471
|
-
# Webhook event: <a href="https://
|
|
471
|
+
# Webhook event: <a href="https://fastpix.com/docs/live-stream-events/live-events#videolive_streamsimulcast_targetupdated">video.live_stream.simulcast_target.updated</a>
|
|
472
472
|
#
|
|
473
473
|
# #### Example
|
|
474
474
|
# When a `PATCH` request is made to this endpoint, the API updates the status of the simulcast. This can be useful for pausing or resuming a simulcast on a particular platform without stopping the parent live stream.
|
|
@@ -42,7 +42,7 @@ module FastpixClient
|
|
|
42
42
|
sig { params(request: Models::Components::CreateLiveStreamRequest, timeout_ms: T.nilable(Integer)).returns(Models::Operations::CreateNewStreamResponse) }
|
|
43
43
|
def create_new_stream(request:, timeout_ms: nil)
|
|
44
44
|
# create_new_stream - Create a new stream
|
|
45
|
-
# Creates a new <a href="https://
|
|
45
|
+
# Creates a new <a href="https://fastpix.com/docs/get-started/live-overview">RTMPS</a> or <a href="https://fastpix.com/docs/broadcast/live-stream-with-srt">SRT</a> live stream in FastPix. When you create a stream, FastPix generates a unique `streamKey` and `srtSecret` that you can use with broadcasting software such as OBS to connect to FastPix RTMPS or SRT servers. Use SRT for live streaming in unstable network conditions, as it provides error correction and encryption for a more reliable and secure broadcast.
|
|
46
46
|
#
|
|
47
47
|
# Leverage SRT for live streaming in environments with unstable networks, taking advantage of its error correction and encryption features for a resilient and secure broadcast.
|
|
48
48
|
#
|
|
@@ -52,7 +52,7 @@ module FastpixClient
|
|
|
52
52
|
#
|
|
53
53
|
# 2. FastPix returns the stream details for both RTMPS and SRT configurations. These keys and IDs from the stream details are essential for connecting the broadcasting software to FastPix’s servers and transmitting the live stream to viewers.
|
|
54
54
|
#
|
|
55
|
-
# 3. After the live stream is created, FastPix sends a `POST` request to your specified webhook endpoint with the event <a href="https://
|
|
55
|
+
# 3. After the live stream is created, FastPix sends a `POST` request to your specified webhook endpoint with the event <a href="https://fastpix.com/docs/live-stream-events/live-events#videolive_streamcreated">video.live_stream.created</a>.
|
|
56
56
|
#
|
|
57
57
|
#
|
|
58
58
|
# **Example:**
|
|
@@ -61,7 +61,7 @@ module FastpixClient
|
|
|
61
61
|
# Imagine a gaming platform that allows users to live stream gameplay directly from their dashboard. The API creates a new stream, provides the necessary stream key, and sets it to "private" so that only specific viewers can access it.
|
|
62
62
|
#
|
|
63
63
|
#
|
|
64
|
-
# Related guide: <a href="https://
|
|
64
|
+
# Related guide: <a href="https://fastpix.com/docs/get-started/live-quickstart">How to live stream</a>
|
|
65
65
|
url, params = @sdk_configuration.get_server_details
|
|
66
66
|
base_url = Utils.template_url(url, params)
|
|
67
67
|
url = "#{base_url}/live/streams"
|
|
@@ -74,6 +74,11 @@ module FastpixClient
|
|
|
74
74
|
end
|
|
75
75
|
path = path.sub("{#{param_metadata.fetch(:field_name, f.name)}}", pp_vals.join(','))
|
|
76
76
|
else
|
|
77
|
+
if param.class.respond_to?(:enums)
|
|
78
|
+
param = T.cast(param, T::Enum).serialize
|
|
79
|
+
elsif param.is_a? DateTime
|
|
80
|
+
param = param.strftime('%Y-%m-%dT%H:%M:%S.%NZ')
|
|
81
|
+
end
|
|
77
82
|
path = path.sub("{#{param_metadata.fetch(:field_name, f.name)}}", param.to_s)
|
|
78
83
|
end
|
|
79
84
|
end
|
data/lib/fastpix_client/views.rb
CHANGED
|
@@ -51,7 +51,7 @@ module FastpixClient
|
|
|
51
51
|
#
|
|
52
52
|
# 2. Specify the timespan for which you want to retrieve the video views using the `timespan[]` parameter.
|
|
53
53
|
#
|
|
54
|
-
# 3. Filter the views based on dimensions such as browser, device, video title, viewer ID, etc., using the `filterby[]` parameter. Get the dimensions by calling <a href="https://
|
|
54
|
+
# 3. Filter the views based on dimensions such as browser, device, video title, viewer ID, etc., using the `filterby[]` parameter. Get the dimensions by calling <a href="https://fastpix.com/docs/video-data-api/dimensions/list-dimensions">list the dimensions</a> endpoint.
|
|
55
55
|
#
|
|
56
56
|
# 4. Paginate the results using the `limit` and `offset` parameters.
|
|
57
57
|
#
|
|
@@ -59,7 +59,7 @@ module FastpixClient
|
|
|
59
59
|
#
|
|
60
60
|
# 6. You receive a response containing the list of video views matching the specified criteria.
|
|
61
61
|
#
|
|
62
|
-
# Each view in the response includes a unique `viewId`. You can use this `viewId` with the <a href="https://
|
|
62
|
+
# Each view in the response includes a unique `viewId`. You can use this `viewId` with the <a href="https://fastpix.com/docs/video-data-api/views/get-video-view-details">Get Video View Details</a> endpoint to retrieve more detailed information about that specific view.
|
|
63
63
|
#
|
|
64
64
|
#
|
|
65
65
|
# #### Example
|
|
@@ -67,7 +67,7 @@ module FastpixClient
|
|
|
67
67
|
# If you manage a video streaming service and want to analyze content performance across devices and browsers. By calling the List Video Views endpoint with filters such as `browser_name` and `device_type`, you can identify which platforms are most popular with your audience. This information helps optimize content for widely used platforms and troubleshoot playback issues on less common devices.
|
|
68
68
|
#
|
|
69
69
|
#
|
|
70
|
-
# Related guide: <a href="https://
|
|
70
|
+
# Related guide: <a href="https://fastpix.com/docs/concepts/audience-metrics">Audience metrics</a>, <a href="https://fastpix.com/docs/working-with-video-data/explore-the-dashboard#1-views-dashboard">Views dashboard</a>
|
|
71
71
|
url, params = @sdk_configuration.get_server_details
|
|
72
72
|
base_url = Utils.template_url(url, params)
|
|
73
73
|
url = "#{base_url}/data/viewlist"
|
|
@@ -201,7 +201,7 @@ module FastpixClient
|
|
|
201
201
|
# If a developer receives a report of a poor viewing experience for a specific user. By using this endpoint with the users `viewId`, the developer can retrieve metrics like buffering duration, playback errors, and session length. This data allows the developer to pinpoint issues (such as poor connectivity or a browser-specific problem) and take steps to improve the user experience.
|
|
202
202
|
#
|
|
203
203
|
#
|
|
204
|
-
# Related guide: <a href="https://
|
|
204
|
+
# Related guide: <a href="https://fastpix.com/docs/concepts/what-video-data-do-we-capture#/">What Video Data do we capture?</a>
|
|
205
205
|
request = Models::Operations::GetVideoViewDetailsRequest.new(
|
|
206
206
|
view_id: view_id
|
|
207
207
|
)
|
|
@@ -346,7 +346,7 @@ module FastpixClient
|
|
|
346
346
|
# 5. You receive a response containing the list of top video views matching the specified criteria.
|
|
347
347
|
#
|
|
348
348
|
#
|
|
349
|
-
# Related guide: <a href="https://
|
|
349
|
+
# Related guide: <a href="https://fastpix.com/docs/working-with-video-data/identify-top-performing-content">Get top-performing content</a>
|
|
350
350
|
#
|
|
351
351
|
request = Models::Operations::ListByTopContentRequest.new(
|
|
352
352
|
timespan: timespan,
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: fastpixapi
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.1.
|
|
4
|
+
version: 1.1.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- FastPix
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-
|
|
11
|
+
date: 2026-05-26 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: base64
|
|
@@ -100,6 +100,20 @@ dependencies:
|
|
|
100
100
|
- - "~>"
|
|
101
101
|
- !ruby/object:Gem::Version
|
|
102
102
|
version: '1.0'
|
|
103
|
+
- !ruby/object:Gem::Dependency
|
|
104
|
+
name: json_schemer
|
|
105
|
+
requirement: !ruby/object:Gem::Requirement
|
|
106
|
+
requirements:
|
|
107
|
+
- - "~>"
|
|
108
|
+
- !ruby/object:Gem::Version
|
|
109
|
+
version: '2.3'
|
|
110
|
+
type: :development
|
|
111
|
+
prerelease: false
|
|
112
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
113
|
+
requirements:
|
|
114
|
+
- - "~>"
|
|
115
|
+
- !ruby/object:Gem::Version
|
|
116
|
+
version: '2.3'
|
|
103
117
|
- !ruby/object:Gem::Dependency
|
|
104
118
|
name: minitest
|
|
105
119
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -222,7 +236,7 @@ description: A robust, type-safe Ruby SDK for seamless integration with the Fast
|
|
|
222
236
|
API platform for media uploads, live streaming, playlists, analytics, and signing
|
|
223
237
|
keys.
|
|
224
238
|
email:
|
|
225
|
-
- devs@fastpix.
|
|
239
|
+
- devs@fastpix.com
|
|
226
240
|
executables: []
|
|
227
241
|
extensions: []
|
|
228
242
|
extra_rdoc_files: []
|
|
@@ -344,6 +358,7 @@ files:
|
|
|
344
358
|
- lib/fastpix_client/models/components/default_error.rbi
|
|
345
359
|
- lib/fastpix_client/models/components/deletesigningkeyresponse.rb
|
|
346
360
|
- lib/fastpix_client/models/components/deletesigningkeyresponse.rbi
|
|
361
|
+
- lib/fastpix_client/models/components/deletesigningkeyresponsedata.rb
|
|
347
362
|
- lib/fastpix_client/models/components/directupload.rb
|
|
348
363
|
- lib/fastpix_client/models/components/directupload.rbi
|
|
349
364
|
- lib/fastpix_client/models/components/directupload_status.rb
|
|
@@ -1211,7 +1226,7 @@ files:
|
|
|
1211
1226
|
- lib/openssl_patch.rb
|
|
1212
1227
|
- test/sdk_examples_test.rb
|
|
1213
1228
|
- test/test_helper.rb
|
|
1214
|
-
homepage: https://
|
|
1229
|
+
homepage: https://fastpix.com/docs
|
|
1215
1230
|
licenses:
|
|
1216
1231
|
- Apache-2.0
|
|
1217
1232
|
metadata: {}
|