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
|
@@ -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::UpdateTrackResponseType), 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::UpdateTrackResponseType), 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
|
|
@@ -24,15 +24,18 @@ module FastpixClient
|
|
|
24
24
|
field :frame_rate, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('frameRate') } }
|
|
25
25
|
# Indicates the current state of the track. 'available' means the track has been processed successfully and is ready to be used or played.
|
|
26
26
|
field :status, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('status') } }
|
|
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(::String), width: T.nilable(::Float), height: T.nilable(::Float), frame_rate: T.nilable(::String), status: T.nilable(::String)).void }
|
|
29
|
-
def initialize(id: nil, type: nil, width: nil, height: nil, frame_rate: nil, status: nil)
|
|
30
|
+
sig { params(id: T.nilable(::String), type: T.nilable(::String), width: T.nilable(::Float), height: T.nilable(::Float), frame_rate: T.nilable(::String), status: T.nilable(::String), title: T.nilable(::String)).void }
|
|
31
|
+
def initialize(id: nil, type: nil, width: nil, height: nil, frame_rate: nil, status: nil, title: nil)
|
|
30
32
|
@id = id
|
|
31
33
|
@type = type
|
|
32
34
|
@width = width
|
|
33
35
|
@height = height
|
|
34
36
|
@frame_rate = frame_rate
|
|
35
37
|
@status = status
|
|
38
|
+
@title = title
|
|
36
39
|
end
|
|
37
40
|
|
|
38
41
|
sig { params(other: T.untyped).returns(T::Boolean) }
|
|
@@ -44,6 +47,7 @@ module FastpixClient
|
|
|
44
47
|
return false unless @height == other.height
|
|
45
48
|
return false unless @frame_rate == other.frame_rate
|
|
46
49
|
return false unless @status == other.status
|
|
50
|
+
return false unless @title == other.title
|
|
47
51
|
true
|
|
48
52
|
end
|
|
49
53
|
end
|
|
@@ -22,14 +22,17 @@ module FastpixClient
|
|
|
22
22
|
field :height, Crystalline::Nilable.new(::Float), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('height') } }
|
|
23
23
|
# Indicates the current state of the track. 'available' means the track has been processed successfully and is ready to be used or played.
|
|
24
24
|
field :status, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('status') } }
|
|
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(::String), width: T.nilable(::Float), height: T.nilable(::Float), status: T.nilable(::String)).void }
|
|
27
|
-
def initialize(id: nil, type: nil, width: nil, height: nil, status: nil)
|
|
28
|
+
sig { params(id: T.nilable(::String), type: T.nilable(::String), width: T.nilable(::Float), height: T.nilable(::Float), status: T.nilable(::String), title: T.nilable(::String)).void }
|
|
29
|
+
def initialize(id: nil, type: nil, width: nil, height: nil, status: nil, title: nil)
|
|
28
30
|
@id = id
|
|
29
31
|
@type = type
|
|
30
32
|
@width = width
|
|
31
33
|
@height = height
|
|
32
34
|
@status = status
|
|
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 @width == other.width
|
|
41
44
|
return false unless @height == other.height
|
|
42
45
|
return false unless @status == other.status
|
|
46
|
+
return false unless @title == other.title
|
|
43
47
|
true
|
|
44
48
|
end
|
|
45
49
|
end
|
|
@@ -77,13 +77,13 @@ module FastpixClient
|
|
|
77
77
|
autoload :GetAllPlaylistsResponse, 'fastpix_client/models/components/getallplaylistsresponse.rb'
|
|
78
78
|
autoload :GetAllSigningKeysResponse, 'fastpix_client/models/components/getallsigningkeysresponse.rb'
|
|
79
79
|
autoload :GetAllSigningKeysResponseDto, 'fastpix_client/models/components/getallsigningkeysresponsedto.rb'
|
|
80
|
-
autoload :
|
|
81
|
-
autoload :
|
|
82
|
-
autoload :
|
|
83
|
-
autoload :
|
|
84
|
-
autoload :
|
|
85
|
-
autoload :
|
|
86
|
-
autoload :
|
|
80
|
+
autoload :GetMediaDetailResponse, 'fastpix_client/models/components/getmediadetailresponse.rb'
|
|
81
|
+
autoload :GetMediaDetailResponseMaxResolution, 'fastpix_client/models/components/getmediadetailresponse_maxresolution.rb'
|
|
82
|
+
autoload :GetMediaDetailResponseMediaQuality, 'fastpix_client/models/components/getmediadetailresponse_mediaquality.rb'
|
|
83
|
+
autoload :GetMediaDetailResponseMp4Support, 'fastpix_client/models/components/getmediadetailresponse_mp4support.rb'
|
|
84
|
+
autoload :GetMediaDetailResponseSourceResolution, 'fastpix_client/models/components/getmediadetailresponse_sourceresolution.rb'
|
|
85
|
+
autoload :GetMediaDetailResponseStatus, 'fastpix_client/models/components/getmediadetailresponse_status.rb'
|
|
86
|
+
autoload :GetMediaDetailResponseTrack, 'fastpix_client/models/components/getmediadetailresponse_track.rb'
|
|
87
87
|
autoload :LanguageCode, 'fastpix_client/models/components/languagecode.rb'
|
|
88
88
|
autoload :LiveMediaClips, 'fastpix_client/models/components/live_media_clips.rb'
|
|
89
89
|
autoload :LiveMediaClipsMaxResolution, 'fastpix_client/models/components/live_media_clips_maxresolution.rb'
|
|
@@ -20,7 +20,7 @@ module FastpixClient
|
|
|
20
20
|
field :raw_response, ::Faraday::Response
|
|
21
21
|
# Get a video media by id
|
|
22
22
|
field :object, Crystalline::Nilable.new(Models::Operations::GetMediaResponseBody)
|
|
23
|
-
# See the range of possible <a href="https://fastpix.com/docs/error-codes">error</a> responses and their status codes.
|
|
23
|
+
# See the range of possible <a href="https://fastpix.com/docs/error-codes/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::GetMediaResponseBody), default_error: T.nilable(Models::Components::DefaultError)).void }
|
|
@@ -15,9 +15,9 @@ module FastpixClient
|
|
|
15
15
|
# Demonstrates whether the request is successful or not.
|
|
16
16
|
field :success, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('success') } }
|
|
17
17
|
|
|
18
|
-
field :data, Crystalline::Nilable.new(Models::Components::
|
|
18
|
+
field :data, Crystalline::Nilable.new(Models::Components::GetMediaDetailResponse), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('data') } }
|
|
19
19
|
|
|
20
|
-
sig { params(success: T.nilable(T::Boolean), data: T.nilable(Models::Components::
|
|
20
|
+
sig { params(success: T.nilable(T::Boolean), data: T.nilable(Models::Components::GetMediaDetailResponse)).void }
|
|
21
21
|
def initialize(success: nil, data: nil)
|
|
22
22
|
@success = success
|
|
23
23
|
@data = data
|
|
@@ -101,7 +101,8 @@ module FastpixClient
|
|
|
101
101
|
# - **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.
|
|
102
102
|
# - **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.
|
|
103
103
|
#
|
|
104
|
-
# For more details, see <a href="https://fastpix.com/docs/
|
|
104
|
+
# For more details, see <a href="https://fastpix.com/docs/video-on-demand/create-and-manage-playlists">Create and manage playlist</a>.
|
|
105
|
+
|
|
105
106
|
#
|
|
106
107
|
# #### How it works
|
|
107
108
|
#
|
|
@@ -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.4'
|
|
95
95
|
@gen_version = '2.801.0'
|
|
96
|
-
@user_agent = 'fastpixapi-ruby 1.1.
|
|
96
|
+
@user_agent = 'fastpixapi-ruby 1.1.4'
|
|
97
97
|
end
|
|
98
98
|
|
|
99
99
|
sig { returns([String, T::Hash[Symbol, String]]) }
|
|
@@ -104,7 +104,7 @@ module FastpixClient
|
|
|
104
104
|
# #### Example
|
|
105
105
|
# 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.
|
|
106
106
|
#
|
|
107
|
-
# Related guide: <a href="https://fastpix.com/docs/
|
|
107
|
+
# Related guide: <a href="https://fastpix.com/docs/live-streaming/simulcast-to-multiple-platforms">Simulcast to 3rd party platforms</a>
|
|
108
108
|
request = Models::Operations::CreateSimulcastOfStreamRequest.new(
|
|
109
109
|
stream_id: stream_id,
|
|
110
110
|
body: body
|
|
@@ -221,7 +221,7 @@ module FastpixClient
|
|
|
221
221
|
# delete_simulcast_of_stream - Delete a simulcast
|
|
222
222
|
# 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.
|
|
223
223
|
#
|
|
224
|
-
# Webhook event: <a href="https://fastpix.com/docs/
|
|
224
|
+
# Webhook event: <a href="https://fastpix.com/docs/webhooks/live-events#videolive_streamsimulcast_targetdeleted">video.live_stream.simulcast_target.deleted</a>
|
|
225
225
|
#
|
|
226
226
|
#
|
|
227
227
|
# #### Example
|
|
@@ -452,7 +452,7 @@ module FastpixClient
|
|
|
452
452
|
# update_specific_simulcast_of_stream - Update a simulcast
|
|
453
453
|
# 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.
|
|
454
454
|
#
|
|
455
|
-
# Webhook event: <a href="https://fastpix.com/docs/
|
|
455
|
+
# Webhook event: <a href="https://fastpix.com/docs/webhooks/live-events#videolive_streamsimulcast_targetupdated">video.live_stream.simulcast_target.updated</a>
|
|
456
456
|
#
|
|
457
457
|
# #### Example
|
|
458
458
|
# 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.
|
|
@@ -88,7 +88,8 @@ module FastpixClient
|
|
|
88
88
|
sig { params(request: Models::Components::CreateLiveStreamRequest, timeout_ms: T.nilable(Integer)).returns(Models::Operations::CreateNewStreamResponse) }
|
|
89
89
|
def create_new_stream(request:, timeout_ms: nil)
|
|
90
90
|
# create_new_stream - Create a new stream
|
|
91
|
-
# Creates a new <a href="https://fastpix.com/docs/
|
|
91
|
+
# Creates a new <a href="https://fastpix.com/docs/live-streaming/live-stream-with-rtmps">RTMPS</a> or <a href="https://fastpix.com/docs/live-streaming/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.
|
|
92
|
+
|
|
92
93
|
#
|
|
93
94
|
# 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.
|
|
94
95
|
#
|
|
@@ -98,8 +99,7 @@ module FastpixClient
|
|
|
98
99
|
#
|
|
99
100
|
# 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.
|
|
100
101
|
#
|
|
101
|
-
# 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/
|
|
102
|
-
#
|
|
102
|
+
# 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/webhooks/live-events#videolive_streamcreated">video.live_stream.created</a>.
|
|
103
103
|
#
|
|
104
104
|
# **Example:**
|
|
105
105
|
#
|
|
@@ -107,7 +107,7 @@ module FastpixClient
|
|
|
107
107
|
# 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.
|
|
108
108
|
#
|
|
109
109
|
#
|
|
110
|
-
# Related guide: <a href="https://fastpix.com/docs/
|
|
110
|
+
# Related guide: <a href="https://fastpix.com/docs/live-streaming/quickstart">How to live stream</a>
|
|
111
111
|
url, params = @sdk_configuration.get_server_details
|
|
112
112
|
base_url = Utils.template_url(url, params)
|
|
113
113
|
url = "#{base_url}/live/streams"
|
data/lib/fastpix_client/views.rb
CHANGED
|
@@ -103,7 +103,7 @@ module FastpixClient
|
|
|
103
103
|
# 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.
|
|
104
104
|
#
|
|
105
105
|
#
|
|
106
|
-
#
|
|
106
|
+
# Related guide: <a href="https://fastpix.com/docs/video-data/audience-metrics">Audience metrics</a>, <a href="https://fastpix.com/docs/video-data/explore-the-dashboard#1-views-dashboard">Views dashboard</a>
|
|
107
107
|
url, params = @sdk_configuration.get_server_details
|
|
108
108
|
base_url = Utils.template_url(url, params)
|
|
109
109
|
url = "#{base_url}/data/viewlist"
|
|
@@ -217,7 +217,7 @@ module FastpixClient
|
|
|
217
217
|
# 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.
|
|
218
218
|
#
|
|
219
219
|
#
|
|
220
|
-
# Related guide: <a href="https://fastpix.com/docs/
|
|
220
|
+
# Related guide: <a href="https://fastpix.com/docs/video-data/what-video-data-do-we-capture">What Video Data do we capture?</a>
|
|
221
221
|
request = Models::Operations::GetVideoViewDetailsRequest.new(
|
|
222
222
|
view_id: view_id
|
|
223
223
|
)
|
|
@@ -342,7 +342,7 @@ module FastpixClient
|
|
|
342
342
|
# 5. You receive a response containing the list of top video views matching the specified criteria.
|
|
343
343
|
#
|
|
344
344
|
#
|
|
345
|
-
#
|
|
345
|
+
# Related guide: <a href="https://fastpix.com/docs/video-data/identify-top-performing-content">Get top-performing content</a>
|
|
346
346
|
#
|
|
347
347
|
request = Models::Operations::ListByTopContentRequest.new(
|
|
348
348
|
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.4
|
|
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-08-03 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: base64
|
|
@@ -411,20 +411,20 @@ files:
|
|
|
411
411
|
- lib/fastpix_client/models/components/getallsigningkeysresponsedto.rbi
|
|
412
412
|
- lib/fastpix_client/models/components/getcreatelivestreamresponsedto.rb
|
|
413
413
|
- lib/fastpix_client/models/components/getcreatelivestreamresponsedto.rbi
|
|
414
|
-
- lib/fastpix_client/models/components/
|
|
415
|
-
- lib/fastpix_client/models/components/
|
|
416
|
-
- lib/fastpix_client/models/components/
|
|
417
|
-
- lib/fastpix_client/models/components/
|
|
418
|
-
- lib/fastpix_client/models/components/
|
|
419
|
-
- lib/fastpix_client/models/components/
|
|
420
|
-
- lib/fastpix_client/models/components/
|
|
421
|
-
- lib/fastpix_client/models/components/
|
|
422
|
-
- lib/fastpix_client/models/components/
|
|
423
|
-
- lib/fastpix_client/models/components/
|
|
424
|
-
- lib/fastpix_client/models/components/
|
|
425
|
-
- lib/fastpix_client/models/components/
|
|
426
|
-
- lib/fastpix_client/models/components/
|
|
427
|
-
- lib/fastpix_client/models/components/
|
|
414
|
+
- lib/fastpix_client/models/components/getmediadetailresponse.rb
|
|
415
|
+
- lib/fastpix_client/models/components/getmediadetailresponse.rbi
|
|
416
|
+
- lib/fastpix_client/models/components/getmediadetailresponse_maxresolution.rb
|
|
417
|
+
- lib/fastpix_client/models/components/getmediadetailresponse_maxresolution.rbi
|
|
418
|
+
- lib/fastpix_client/models/components/getmediadetailresponse_mediaquality.rb
|
|
419
|
+
- lib/fastpix_client/models/components/getmediadetailresponse_mediaquality.rbi
|
|
420
|
+
- lib/fastpix_client/models/components/getmediadetailresponse_mp4support.rb
|
|
421
|
+
- lib/fastpix_client/models/components/getmediadetailresponse_mp4support.rbi
|
|
422
|
+
- lib/fastpix_client/models/components/getmediadetailresponse_sourceresolution.rb
|
|
423
|
+
- lib/fastpix_client/models/components/getmediadetailresponse_sourceresolution.rbi
|
|
424
|
+
- lib/fastpix_client/models/components/getmediadetailresponse_status.rb
|
|
425
|
+
- lib/fastpix_client/models/components/getmediadetailresponse_status.rbi
|
|
426
|
+
- lib/fastpix_client/models/components/getmediadetailresponse_track.rb
|
|
427
|
+
- lib/fastpix_client/models/components/getmediadetailresponse_track.rbi
|
|
428
428
|
- lib/fastpix_client/models/components/getpublicpemusingsigningkeyidresponsedto.rb
|
|
429
429
|
- lib/fastpix_client/models/components/getpublicpemusingsigningkeyidresponsedto.rbi
|
|
430
430
|
- lib/fastpix_client/models/components/getpublicpemusingsigningkeyidresponsedto_data.rb
|
|
@@ -1225,8 +1225,6 @@ files:
|
|
|
1225
1225
|
- lib/fastpix_client/views.rb
|
|
1226
1226
|
- lib/fastpixapi.rb
|
|
1227
1227
|
- lib/openssl_patch.rb
|
|
1228
|
-
- test/sdk_examples_test.rb
|
|
1229
|
-
- test/test_helper.rb
|
|
1230
1228
|
homepage: https://fastpix.com/docs
|
|
1231
1229
|
licenses:
|
|
1232
1230
|
- Apache-2.0
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
# typed: true
|
|
2
|
-
# frozen_string_literal: true
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
class FastpixClient::Models::Components::GetMediaResponseMaxResolution
|
|
6
|
-
extend ::Crystalline::MetadataFields::ClassMethods
|
|
7
|
-
end
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
class FastpixClient::Models::Components::GetMediaResponseMaxResolution
|
|
11
|
-
end
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
# typed: true
|
|
2
|
-
# frozen_string_literal: true
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
class FastpixClient::Models::Components::GetMediaResponseMediaQuality
|
|
6
|
-
extend ::Crystalline::MetadataFields::ClassMethods
|
|
7
|
-
end
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
class FastpixClient::Models::Components::GetMediaResponseMediaQuality
|
|
11
|
-
end
|
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
# Generated code for FastPix API SDK.
|
|
2
|
-
|
|
3
|
-
# typed: true
|
|
4
|
-
# frozen_string_literal: true
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
module FastpixClient
|
|
8
|
-
module Models
|
|
9
|
-
module Components
|
|
10
|
-
# GetMediaResponseMp4Support - Determines the type of MP4 support for the media.
|
|
11
|
-
# - **none**: Disables MP4 support.
|
|
12
|
-
# - **capped_4k**: Enables MP4 downloads with resolutions up to 4K.
|
|
13
|
-
# - **audioOnly**: Provides an MP4 stream containing only the audio.
|
|
14
|
-
# - **audioOnly,capped_4k**: Enables both MP4 video downloads (up to 4K) and an audio-only stream.
|
|
15
|
-
#
|
|
16
|
-
class GetMediaResponseMp4Support < T::Enum
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
enums do
|
|
20
|
-
NONE = new('none')
|
|
21
|
-
CAPPED_4K = new('capped_4k')
|
|
22
|
-
AUDIO_ONLY = new('audioOnly')
|
|
23
|
-
AUDIO_ONLY_CAPPED_4K = new('audioOnly,capped_4k')
|
|
24
|
-
end
|
|
25
|
-
end
|
|
26
|
-
end
|
|
27
|
-
end
|
|
28
|
-
end
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
# typed: true
|
|
2
|
-
# frozen_string_literal: true
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
class FastpixClient::Models::Components::GetMediaResponseMp4Support
|
|
6
|
-
extend ::Crystalline::MetadataFields::ClassMethods
|
|
7
|
-
end
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
class FastpixClient::Models::Components::GetMediaResponseMp4Support
|
|
11
|
-
end
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
# typed: true
|
|
2
|
-
# frozen_string_literal: true
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
class FastpixClient::Models::Components::GetMediaResponseSourceResolution
|
|
6
|
-
extend ::Crystalline::MetadataFields::ClassMethods
|
|
7
|
-
end
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
class FastpixClient::Models::Components::GetMediaResponseSourceResolution
|
|
11
|
-
end
|
data/test/sdk_examples_test.rb
DELETED
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
require 'json'
|
|
2
|
-
require 'fastpixapi'
|
|
3
|
-
|
|
4
|
-
Models = ::FastpixClient::Models
|
|
5
|
-
s = ::FastpixClient::Fastpixapi.new(
|
|
6
|
-
security: Models::Components::Security.new(
|
|
7
|
-
username: 'your-access-token',
|
|
8
|
-
password: 'your-secret-key'
|
|
9
|
-
),
|
|
10
|
-
)
|
|
11
|
-
|
|
12
|
-
res = s.manage_videos.list_media(limit: 20, offset: 1, order_by: Models::Components::SortOrder::DESC)
|
|
13
|
-
|
|
14
|
-
begin
|
|
15
|
-
puts JSON.pretty_generate(JSON.parse(res.raw_response.body))
|
|
16
|
-
rescue FastpixClient::Models::Errors::APIError => e
|
|
17
|
-
puts JSON.pretty_generate(JSON.parse(e.body))
|
|
18
|
-
rescue StandardError
|
|
19
|
-
puts res.raw_response.body.to_s
|
|
20
|
-
end
|
data/test/test_helper.rb
DELETED
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
|
|
4
|
-
|
|
5
|
-
require 'json'
|
|
6
|
-
require 'minitest/autorun'
|
|
7
|
-
require 'fastpixapi'
|
|
8
|
-
|
|
9
|
-
# Standard response handling for any SDK operation. Prints only the JSON body.
|
|
10
|
-
# res = s.input_video.create_media(request: req)
|
|
11
|
-
# print_response(res)
|
|
12
|
-
def print_response(res)
|
|
13
|
-
begin
|
|
14
|
-
puts JSON.pretty_generate(JSON.parse(res.raw_response.body))
|
|
15
|
-
rescue StandardError
|
|
16
|
-
puts res.raw_response.body.to_s
|
|
17
|
-
end
|
|
18
|
-
end
|
|
19
|
-
|
|
20
|
-
# Standard error handling when the SDK raises APIError (4xx/5xx). Prints only the JSON body.
|
|
21
|
-
# rescue FastpixClient::Models::Errors::APIError => e
|
|
22
|
-
# print_api_error(e)
|
|
23
|
-
def print_api_error(err)
|
|
24
|
-
begin
|
|
25
|
-
puts JSON.pretty_generate(JSON.parse(err.body))
|
|
26
|
-
rescue StandardError
|
|
27
|
-
puts err.body.to_s
|
|
28
|
-
end
|
|
29
|
-
end
|