@fastpix/fastpix-node 2.0.5 → 2.0.6
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.
- package/FUNCTIONS.md +1 -1
- package/README.md +11 -11
- package/dist/commonjs/funcs/aiFeaturesGenerateNamedEntities.d.ts +2 -2
- package/dist/commonjs/funcs/aiFeaturesGenerateNamedEntities.js +2 -2
- package/dist/commonjs/funcs/aiFeaturesUpdateSummary.d.ts +2 -2
- package/dist/commonjs/funcs/aiFeaturesUpdateSummary.js +2 -2
- package/dist/commonjs/funcs/dimensionsList.d.ts +2 -2
- package/dist/commonjs/funcs/dimensionsList.js +2 -2
- package/dist/commonjs/funcs/dimensionsListFilterValues.d.ts +2 -2
- package/dist/commonjs/funcs/dimensionsListFilterValues.js +2 -2
- package/dist/commonjs/funcs/drmConfigurationsGet.d.ts +1 -1
- package/dist/commonjs/funcs/drmConfigurationsGet.js +1 -1
- package/dist/commonjs/funcs/drmConfigurationsList.d.ts +1 -1
- package/dist/commonjs/funcs/drmConfigurationsList.js +1 -1
- package/dist/commonjs/funcs/errorsList.d.ts +1 -1
- package/dist/commonjs/funcs/errorsList.js +1 -1
- package/dist/commonjs/funcs/inVideoAIUpdateModeration.d.ts +2 -2
- package/dist/commonjs/funcs/inVideoAIUpdateModeration.js +2 -2
- package/dist/commonjs/funcs/inVideoAIfeaturesGenerateChapters.d.ts +2 -2
- package/dist/commonjs/funcs/inVideoAIfeaturesGenerateChapters.js +2 -2
- package/dist/commonjs/funcs/inputVideoCreate.d.ts +4 -4
- package/dist/commonjs/funcs/inputVideoCreate.js +4 -4
- package/dist/commonjs/funcs/inputVideoUpload.d.ts +5 -5
- package/dist/commonjs/funcs/inputVideoUpload.js +5 -5
- package/dist/commonjs/funcs/liveStreamsCreate.d.ts +3 -3
- package/dist/commonjs/funcs/liveStreamsCreate.js +3 -3
- package/dist/commonjs/funcs/liveStreamsDelete.d.ts +2 -2
- package/dist/commonjs/funcs/liveStreamsDelete.js +2 -2
- package/dist/commonjs/funcs/liveStreamsEnable.d.ts +1 -1
- package/dist/commonjs/funcs/liveStreamsEnable.js +1 -1
- package/dist/commonjs/funcs/liveStreamsListClips.d.ts +1 -1
- package/dist/commonjs/funcs/liveStreamsListClips.js +1 -1
- package/dist/commonjs/funcs/manageLiveStreamComplete.d.ts +1 -1
- package/dist/commonjs/funcs/manageLiveStreamComplete.js +1 -1
- package/dist/commonjs/funcs/manageLiveStreamDisable.d.ts +1 -1
- package/dist/commonjs/funcs/manageLiveStreamDisable.js +1 -1
- package/dist/commonjs/funcs/manageLiveStreamGet.d.ts +1 -1
- package/dist/commonjs/funcs/manageLiveStreamGet.js +1 -1
- package/dist/commonjs/funcs/manageLiveStreamGetViewerCount.d.ts +1 -1
- package/dist/commonjs/funcs/manageLiveStreamGetViewerCount.js +1 -1
- package/dist/commonjs/funcs/manageLiveStreamUpdate.d.ts +2 -2
- package/dist/commonjs/funcs/manageLiveStreamUpdate.js +2 -2
- package/dist/commonjs/funcs/manageVideosAddTrack.d.ts +5 -5
- package/dist/commonjs/funcs/manageVideosAddTrack.js +5 -5
- package/dist/commonjs/funcs/manageVideosCancelUpload.d.ts +1 -1
- package/dist/commonjs/funcs/manageVideosCancelUpload.js +1 -1
- package/dist/commonjs/funcs/manageVideosDelete.d.ts +1 -1
- package/dist/commonjs/funcs/manageVideosDelete.js +1 -1
- package/dist/commonjs/funcs/manageVideosGenerateSubtitleTrack.d.ts +3 -3
- package/dist/commonjs/funcs/manageVideosGenerateSubtitleTrack.js +3 -3
- package/dist/commonjs/funcs/manageVideosGet.d.ts +1 -1
- package/dist/commonjs/funcs/manageVideosGet.js +1 -1
- package/dist/commonjs/funcs/manageVideosUpdate.d.ts +1 -1
- package/dist/commonjs/funcs/manageVideosUpdate.js +1 -1
- package/dist/commonjs/funcs/manageVideosUpdateMp4Support.d.ts +3 -3
- package/dist/commonjs/funcs/manageVideosUpdateMp4Support.js +3 -3
- package/dist/commonjs/funcs/manageVideosUpdateTrack.d.ts +4 -4
- package/dist/commonjs/funcs/manageVideosUpdateTrack.js +4 -4
- package/dist/commonjs/funcs/mediaDeleteTrack.d.ts +2 -2
- package/dist/commonjs/funcs/mediaDeleteTrack.js +2 -2
- package/dist/commonjs/funcs/mediaGetClips.d.ts +1 -1
- package/dist/commonjs/funcs/mediaGetClips.js +1 -1
- package/dist/commonjs/funcs/mediaUpdateSourceAccess.d.ts +1 -1
- package/dist/commonjs/funcs/mediaUpdateSourceAccess.js +1 -1
- package/dist/commonjs/funcs/metricsListBreakdownValues.d.ts +2 -2
- package/dist/commonjs/funcs/metricsListBreakdownValues.js +2 -2
- package/dist/commonjs/funcs/metricsListCompares.d.ts +2 -2
- package/dist/commonjs/funcs/metricsListCompares.js +2 -2
- package/dist/commonjs/funcs/metricsListOverallValues.d.ts +2 -2
- package/dist/commonjs/funcs/metricsListOverallValues.js +2 -2
- package/dist/commonjs/funcs/playbackCreate.d.ts +1 -1
- package/dist/commonjs/funcs/playbackCreate.js +1 -1
- package/dist/commonjs/funcs/playlistCreate.d.ts +1 -1
- package/dist/commonjs/funcs/playlistCreate.js +1 -1
- package/dist/commonjs/funcs/signingKeysCreate.d.ts +1 -1
- package/dist/commonjs/funcs/signingKeysCreate.js +1 -1
- package/dist/commonjs/funcs/signingKeysGetById.d.ts +2 -2
- package/dist/commonjs/funcs/signingKeysGetById.js +2 -2
- package/dist/commonjs/funcs/simulcastStreamsDelete.d.ts +1 -1
- package/dist/commonjs/funcs/simulcastStreamsDelete.js +1 -1
- package/dist/commonjs/funcs/simulcastsCreate.d.ts +2 -2
- package/dist/commonjs/funcs/simulcastsCreate.js +2 -2
- package/dist/commonjs/funcs/simulcastsUpdate.d.ts +1 -1
- package/dist/commonjs/funcs/simulcastsUpdate.js +1 -1
- package/dist/commonjs/funcs/viewsGetDetails.d.ts +1 -1
- package/dist/commonjs/funcs/viewsGetDetails.js +1 -1
- package/dist/commonjs/funcs/viewsList.d.ts +3 -3
- package/dist/commonjs/funcs/viewsList.js +3 -3
- package/dist/commonjs/funcs/viewsListTopContent.d.ts +1 -1
- package/dist/commonjs/funcs/viewsListTopContent.js +1 -1
- package/dist/commonjs/lib/config.d.ts +1 -1
- package/dist/commonjs/lib/config.d.ts.map +1 -1
- package/dist/commonjs/lib/config.js +1 -1
- package/dist/commonjs/lib/config.js.map +1 -1
- package/dist/commonjs/models/addtrackrequest.js +1 -1
- package/dist/commonjs/models/addtrackrequest.js.map +1 -1
- package/dist/commonjs/models/createmediarequest.d.ts +1 -1
- package/dist/commonjs/models/deletesigningkeyresponse.d.ts +10 -0
- package/dist/commonjs/models/deletesigningkeyresponse.d.ts.map +1 -1
- package/dist/commonjs/models/deletesigningkeyresponse.js +1 -0
- package/dist/commonjs/models/deletesigningkeyresponse.js.map +1 -1
- package/dist/commonjs/models/operations/directuploadvideomedia.d.ts +2 -2
- package/dist/commonjs/models/pullvideoinput.js +1 -1
- package/dist/commonjs/models/pullvideoinput.js.map +1 -1
- package/dist/commonjs/models/videotrackforgetall.d.ts +4 -0
- package/dist/commonjs/models/videotrackforgetall.d.ts.map +1 -1
- package/dist/commonjs/models/videotrackforgetall.js +1 -0
- package/dist/commonjs/models/videotrackforgetall.js.map +1 -1
- package/dist/commonjs/models/views.d.ts +3 -3
- package/dist/commonjs/models/views.d.ts.map +1 -1
- package/dist/commonjs/models/views.js +2 -7
- package/dist/commonjs/models/views.js.map +1 -1
- package/dist/commonjs/models/viewslist.d.ts +7 -1
- package/dist/commonjs/models/viewslist.d.ts.map +1 -1
- package/dist/commonjs/models/viewslist.js +3 -7
- package/dist/commonjs/models/viewslist.js.map +1 -1
- package/dist/commonjs/models/watermarkinput.d.ts +1 -1
- package/dist/commonjs/sdk/aifeatures.d.ts +4 -4
- package/dist/commonjs/sdk/aifeatures.js +4 -4
- package/dist/commonjs/sdk/dimensions.d.ts +4 -4
- package/dist/commonjs/sdk/dimensions.js +4 -4
- package/dist/commonjs/sdk/drmconfigurations.d.ts +2 -2
- package/dist/commonjs/sdk/drmconfigurations.js +2 -2
- package/dist/commonjs/sdk/errors.d.ts +1 -1
- package/dist/commonjs/sdk/errors.js +1 -1
- package/dist/commonjs/sdk/inputvideo.d.ts +9 -9
- package/dist/commonjs/sdk/inputvideo.js +9 -9
- package/dist/commonjs/sdk/invideoai.d.ts +2 -2
- package/dist/commonjs/sdk/invideoai.js +2 -2
- package/dist/commonjs/sdk/invideoaifeatures.d.ts +2 -2
- package/dist/commonjs/sdk/invideoaifeatures.js +2 -2
- package/dist/commonjs/sdk/livestreams.d.ts +7 -7
- package/dist/commonjs/sdk/livestreams.js +7 -7
- package/dist/commonjs/sdk/managelivestream.d.ts +6 -6
- package/dist/commonjs/sdk/managelivestream.js +6 -6
- package/dist/commonjs/sdk/managevideos.d.ts +19 -19
- package/dist/commonjs/sdk/managevideos.js +19 -19
- package/dist/commonjs/sdk/media.d.ts +4 -4
- package/dist/commonjs/sdk/media.js +4 -4
- package/dist/commonjs/sdk/metrics.d.ts +6 -6
- package/dist/commonjs/sdk/metrics.js +6 -6
- package/dist/commonjs/sdk/playback.d.ts +1 -1
- package/dist/commonjs/sdk/playback.js +1 -1
- package/dist/commonjs/sdk/playlist.d.ts +1 -1
- package/dist/commonjs/sdk/playlist.js +1 -1
- package/dist/commonjs/sdk/signingkeys.d.ts +3 -3
- package/dist/commonjs/sdk/signingkeys.js +3 -3
- package/dist/commonjs/sdk/simulcasts.d.ts +3 -3
- package/dist/commonjs/sdk/simulcasts.js +3 -3
- package/dist/commonjs/sdk/simulcaststreams.d.ts +1 -1
- package/dist/commonjs/sdk/simulcaststreams.js +1 -1
- package/dist/commonjs/sdk/views.d.ts +5 -5
- package/dist/commonjs/sdk/views.js +5 -5
- package/dist/esm/funcs/aiFeaturesGenerateNamedEntities.d.ts +2 -2
- package/dist/esm/funcs/aiFeaturesGenerateNamedEntities.js +2 -2
- package/dist/esm/funcs/aiFeaturesUpdateSummary.d.ts +2 -2
- package/dist/esm/funcs/aiFeaturesUpdateSummary.js +2 -2
- package/dist/esm/funcs/dimensionsList.d.ts +2 -2
- package/dist/esm/funcs/dimensionsList.js +2 -2
- package/dist/esm/funcs/dimensionsListFilterValues.d.ts +2 -2
- package/dist/esm/funcs/dimensionsListFilterValues.js +2 -2
- package/dist/esm/funcs/drmConfigurationsGet.d.ts +1 -1
- package/dist/esm/funcs/drmConfigurationsGet.js +1 -1
- package/dist/esm/funcs/drmConfigurationsList.d.ts +1 -1
- package/dist/esm/funcs/drmConfigurationsList.js +1 -1
- package/dist/esm/funcs/errorsList.d.ts +1 -1
- package/dist/esm/funcs/errorsList.js +1 -1
- package/dist/esm/funcs/inVideoAIUpdateModeration.d.ts +2 -2
- package/dist/esm/funcs/inVideoAIUpdateModeration.js +2 -2
- package/dist/esm/funcs/inVideoAIfeaturesGenerateChapters.d.ts +2 -2
- package/dist/esm/funcs/inVideoAIfeaturesGenerateChapters.js +2 -2
- package/dist/esm/funcs/inputVideoCreate.d.ts +4 -4
- package/dist/esm/funcs/inputVideoCreate.js +4 -4
- package/dist/esm/funcs/inputVideoUpload.d.ts +5 -5
- package/dist/esm/funcs/inputVideoUpload.js +5 -5
- package/dist/esm/funcs/liveStreamsCreate.d.ts +3 -3
- package/dist/esm/funcs/liveStreamsCreate.js +3 -3
- package/dist/esm/funcs/liveStreamsDelete.d.ts +2 -2
- package/dist/esm/funcs/liveStreamsDelete.js +2 -2
- package/dist/esm/funcs/liveStreamsEnable.d.ts +1 -1
- package/dist/esm/funcs/liveStreamsEnable.js +1 -1
- package/dist/esm/funcs/liveStreamsListClips.d.ts +1 -1
- package/dist/esm/funcs/liveStreamsListClips.js +1 -1
- package/dist/esm/funcs/manageLiveStreamComplete.d.ts +1 -1
- package/dist/esm/funcs/manageLiveStreamComplete.js +1 -1
- package/dist/esm/funcs/manageLiveStreamDisable.d.ts +1 -1
- package/dist/esm/funcs/manageLiveStreamDisable.js +1 -1
- package/dist/esm/funcs/manageLiveStreamGet.d.ts +1 -1
- package/dist/esm/funcs/manageLiveStreamGet.js +1 -1
- package/dist/esm/funcs/manageLiveStreamGetViewerCount.d.ts +1 -1
- package/dist/esm/funcs/manageLiveStreamGetViewerCount.js +1 -1
- package/dist/esm/funcs/manageLiveStreamUpdate.d.ts +2 -2
- package/dist/esm/funcs/manageLiveStreamUpdate.js +2 -2
- package/dist/esm/funcs/manageVideosAddTrack.d.ts +5 -5
- package/dist/esm/funcs/manageVideosAddTrack.js +5 -5
- package/dist/esm/funcs/manageVideosCancelUpload.d.ts +1 -1
- package/dist/esm/funcs/manageVideosCancelUpload.js +1 -1
- package/dist/esm/funcs/manageVideosDelete.d.ts +1 -1
- package/dist/esm/funcs/manageVideosDelete.js +1 -1
- package/dist/esm/funcs/manageVideosGenerateSubtitleTrack.d.ts +3 -3
- package/dist/esm/funcs/manageVideosGenerateSubtitleTrack.js +3 -3
- package/dist/esm/funcs/manageVideosGet.d.ts +1 -1
- package/dist/esm/funcs/manageVideosGet.js +1 -1
- package/dist/esm/funcs/manageVideosUpdate.d.ts +1 -1
- package/dist/esm/funcs/manageVideosUpdate.js +1 -1
- package/dist/esm/funcs/manageVideosUpdateMp4Support.d.ts +3 -3
- package/dist/esm/funcs/manageVideosUpdateMp4Support.js +3 -3
- package/dist/esm/funcs/manageVideosUpdateTrack.d.ts +4 -4
- package/dist/esm/funcs/manageVideosUpdateTrack.js +4 -4
- package/dist/esm/funcs/mediaDeleteTrack.d.ts +2 -2
- package/dist/esm/funcs/mediaDeleteTrack.js +2 -2
- package/dist/esm/funcs/mediaGetClips.d.ts +1 -1
- package/dist/esm/funcs/mediaGetClips.js +1 -1
- package/dist/esm/funcs/mediaUpdateSourceAccess.d.ts +1 -1
- package/dist/esm/funcs/mediaUpdateSourceAccess.js +1 -1
- package/dist/esm/funcs/metricsListBreakdownValues.d.ts +2 -2
- package/dist/esm/funcs/metricsListBreakdownValues.js +2 -2
- package/dist/esm/funcs/metricsListCompares.d.ts +2 -2
- package/dist/esm/funcs/metricsListCompares.js +2 -2
- package/dist/esm/funcs/metricsListOverallValues.d.ts +2 -2
- package/dist/esm/funcs/metricsListOverallValues.js +2 -2
- package/dist/esm/funcs/playbackCreate.d.ts +1 -1
- package/dist/esm/funcs/playbackCreate.js +1 -1
- package/dist/esm/funcs/playlistCreate.d.ts +1 -1
- package/dist/esm/funcs/playlistCreate.js +1 -1
- package/dist/esm/funcs/signingKeysCreate.d.ts +1 -1
- package/dist/esm/funcs/signingKeysCreate.js +1 -1
- package/dist/esm/funcs/signingKeysGetById.d.ts +2 -2
- package/dist/esm/funcs/signingKeysGetById.js +2 -2
- package/dist/esm/funcs/simulcastStreamsDelete.d.ts +1 -1
- package/dist/esm/funcs/simulcastStreamsDelete.js +1 -1
- package/dist/esm/funcs/simulcastsCreate.d.ts +2 -2
- package/dist/esm/funcs/simulcastsCreate.js +2 -2
- package/dist/esm/funcs/simulcastsUpdate.d.ts +1 -1
- package/dist/esm/funcs/simulcastsUpdate.js +1 -1
- package/dist/esm/funcs/viewsGetDetails.d.ts +1 -1
- package/dist/esm/funcs/viewsGetDetails.js +1 -1
- package/dist/esm/funcs/viewsList.d.ts +3 -3
- package/dist/esm/funcs/viewsList.js +3 -3
- package/dist/esm/funcs/viewsListTopContent.d.ts +1 -1
- package/dist/esm/funcs/viewsListTopContent.js +1 -1
- package/dist/esm/lib/config.d.ts +1 -1
- package/dist/esm/lib/config.d.ts.map +1 -1
- package/dist/esm/lib/config.js +1 -1
- package/dist/esm/lib/config.js.map +1 -1
- package/dist/esm/models/addtrackrequest.js +1 -1
- package/dist/esm/models/addtrackrequest.js.map +1 -1
- package/dist/esm/models/createmediarequest.d.ts +1 -1
- package/dist/esm/models/deletesigningkeyresponse.d.ts +10 -0
- package/dist/esm/models/deletesigningkeyresponse.d.ts.map +1 -1
- package/dist/esm/models/deletesigningkeyresponse.js +1 -0
- package/dist/esm/models/deletesigningkeyresponse.js.map +1 -1
- package/dist/esm/models/operations/directuploadvideomedia.d.ts +2 -2
- package/dist/esm/models/pullvideoinput.js +1 -1
- package/dist/esm/models/pullvideoinput.js.map +1 -1
- package/dist/esm/models/videotrackforgetall.d.ts +4 -0
- package/dist/esm/models/videotrackforgetall.d.ts.map +1 -1
- package/dist/esm/models/videotrackforgetall.js +1 -0
- package/dist/esm/models/videotrackforgetall.js.map +1 -1
- package/dist/esm/models/views.d.ts +3 -3
- package/dist/esm/models/views.d.ts.map +1 -1
- package/dist/esm/models/views.js +2 -7
- package/dist/esm/models/views.js.map +1 -1
- package/dist/esm/models/viewslist.d.ts +7 -1
- package/dist/esm/models/viewslist.d.ts.map +1 -1
- package/dist/esm/models/viewslist.js +3 -7
- package/dist/esm/models/viewslist.js.map +1 -1
- package/dist/esm/models/watermarkinput.d.ts +1 -1
- package/dist/esm/sdk/aifeatures.d.ts +4 -4
- package/dist/esm/sdk/aifeatures.js +4 -4
- package/dist/esm/sdk/dimensions.d.ts +4 -4
- package/dist/esm/sdk/dimensions.js +4 -4
- package/dist/esm/sdk/drmconfigurations.d.ts +2 -2
- package/dist/esm/sdk/drmconfigurations.js +2 -2
- package/dist/esm/sdk/errors.d.ts +1 -1
- package/dist/esm/sdk/errors.js +1 -1
- package/dist/esm/sdk/inputvideo.d.ts +9 -9
- package/dist/esm/sdk/inputvideo.js +9 -9
- package/dist/esm/sdk/invideoai.d.ts +2 -2
- package/dist/esm/sdk/invideoai.js +2 -2
- package/dist/esm/sdk/invideoaifeatures.d.ts +2 -2
- package/dist/esm/sdk/invideoaifeatures.js +2 -2
- package/dist/esm/sdk/livestreams.d.ts +7 -7
- package/dist/esm/sdk/livestreams.js +7 -7
- package/dist/esm/sdk/managelivestream.d.ts +6 -6
- package/dist/esm/sdk/managelivestream.js +6 -6
- package/dist/esm/sdk/managevideos.d.ts +19 -19
- package/dist/esm/sdk/managevideos.js +19 -19
- package/dist/esm/sdk/media.d.ts +4 -4
- package/dist/esm/sdk/media.js +4 -4
- package/dist/esm/sdk/metrics.d.ts +6 -6
- package/dist/esm/sdk/metrics.js +6 -6
- package/dist/esm/sdk/playback.d.ts +1 -1
- package/dist/esm/sdk/playback.js +1 -1
- package/dist/esm/sdk/playlist.d.ts +1 -1
- package/dist/esm/sdk/playlist.js +1 -1
- package/dist/esm/sdk/signingkeys.d.ts +3 -3
- package/dist/esm/sdk/signingkeys.js +3 -3
- package/dist/esm/sdk/simulcasts.d.ts +3 -3
- package/dist/esm/sdk/simulcasts.js +3 -3
- package/dist/esm/sdk/simulcaststreams.d.ts +1 -1
- package/dist/esm/sdk/simulcaststreams.js +1 -1
- package/dist/esm/sdk/views.d.ts +5 -5
- package/dist/esm/sdk/views.js +5 -5
- package/examples/inputVideoCreate.example.ts +1 -1
- package/package.json +6 -3
- package/src/funcs/aiFeaturesGenerateNamedEntities.ts +2 -2
- package/src/funcs/aiFeaturesUpdateSummary.ts +2 -2
- package/src/funcs/dimensionsList.ts +2 -2
- package/src/funcs/dimensionsListFilterValues.ts +2 -2
- package/src/funcs/drmConfigurationsGet.ts +1 -1
- package/src/funcs/drmConfigurationsList.ts +1 -1
- package/src/funcs/errorsList.ts +1 -1
- package/src/funcs/inVideoAIUpdateModeration.ts +2 -2
- package/src/funcs/inVideoAIfeaturesGenerateChapters.ts +2 -2
- package/src/funcs/inputVideoCreate.ts +4 -4
- package/src/funcs/inputVideoUpload.ts +5 -5
- package/src/funcs/liveStreamsCreate.ts +3 -3
- package/src/funcs/liveStreamsDelete.ts +2 -2
- package/src/funcs/liveStreamsEnable.ts +1 -1
- package/src/funcs/liveStreamsListClips.ts +1 -1
- package/src/funcs/manageLiveStreamComplete.ts +1 -1
- package/src/funcs/manageLiveStreamDisable.ts +1 -1
- package/src/funcs/manageLiveStreamGet.ts +1 -1
- package/src/funcs/manageLiveStreamGetViewerCount.ts +1 -1
- package/src/funcs/manageLiveStreamUpdate.ts +2 -2
- package/src/funcs/manageVideosAddTrack.ts +5 -5
- package/src/funcs/manageVideosCancelUpload.ts +1 -1
- package/src/funcs/manageVideosDelete.ts +1 -1
- package/src/funcs/manageVideosGenerateSubtitleTrack.ts +3 -3
- package/src/funcs/manageVideosGet.ts +1 -1
- package/src/funcs/manageVideosUpdate.ts +1 -1
- package/src/funcs/manageVideosUpdateMp4Support.ts +3 -3
- package/src/funcs/manageVideosUpdateTrack.ts +4 -4
- package/src/funcs/mediaDeleteTrack.ts +2 -2
- package/src/funcs/mediaGetClips.ts +1 -1
- package/src/funcs/mediaUpdateSourceAccess.ts +1 -1
- package/src/funcs/metricsListBreakdownValues.ts +2 -2
- package/src/funcs/metricsListCompares.ts +2 -2
- package/src/funcs/metricsListOverallValues.ts +2 -2
- package/src/funcs/playbackCreate.ts +1 -1
- package/src/funcs/playlistCreate.ts +1 -1
- package/src/funcs/signingKeysCreate.ts +1 -1
- package/src/funcs/signingKeysGetById.ts +2 -2
- package/src/funcs/simulcastStreamsDelete.ts +1 -1
- package/src/funcs/simulcastsCreate.ts +2 -2
- package/src/funcs/simulcastsUpdate.ts +1 -1
- package/src/funcs/viewsGetDetails.ts +1 -1
- package/src/funcs/viewsList.ts +3 -3
- package/src/funcs/viewsListTopContent.ts +1 -1
- package/src/lib/config.ts +1 -1
- package/src/models/addtrackrequest.ts +1 -1
- package/src/models/createmediarequest.ts +1 -1
- package/src/models/deletesigningkeyresponse.ts +14 -0
- package/src/models/operations/directuploadvideomedia.ts +2 -2
- package/src/models/pullvideoinput.ts +1 -1
- package/src/models/videotrackforgetall.ts +5 -0
- package/src/models/views.ts +5 -13
- package/src/models/viewslist.ts +21 -22
- package/src/models/watermarkinput.ts +1 -1
- package/src/sdk/aifeatures.ts +4 -4
- package/src/sdk/dimensions.ts +4 -4
- package/src/sdk/drmconfigurations.ts +2 -2
- package/src/sdk/errors.ts +1 -1
- package/src/sdk/inputvideo.ts +9 -9
- package/src/sdk/invideoai.ts +2 -2
- package/src/sdk/invideoaifeatures.ts +2 -2
- package/src/sdk/livestreams.ts +7 -7
- package/src/sdk/managelivestream.ts +6 -6
- package/src/sdk/managevideos.ts +19 -19
- package/src/sdk/media.ts +4 -4
- package/src/sdk/metrics.ts +6 -6
- package/src/sdk/playback.ts +1 -1
- package/src/sdk/playlist.ts +1 -1
- package/src/sdk/signingkeys.ts +3 -3
- package/src/sdk/simulcasts.ts +3 -3
- package/src/sdk/simulcaststreams.ts +1 -1
- package/src/sdk/views.ts +5 -5
- package/tests/artifacts/get-all-playlists.api.json +26 -0
- package/tests/artifacts/get-all-playlists.sdk.json +26 -0
- package/tests/artifacts/get-all-streams.api.json +76 -0
- package/tests/artifacts/get-all-streams.sdk.json +76 -0
- package/tests/artifacts/get-live-stream-by-id.api.json +43 -0
- package/tests/artifacts/get-live-stream-by-id.sdk.json +43 -0
- package/tests/artifacts/get-live-stream-playback-id.api.json +7 -0
- package/tests/artifacts/get-live-stream-playback-id.sdk.json +7 -0
- package/tests/artifacts/get-live-stream-viewer-count-by-id.api.json +6 -0
- package/tests/artifacts/get-live-stream-viewer-count-by-id.sdk.json +6 -0
- package/tests/artifacts/get-media-clips.api.json +9 -0
- package/tests/artifacts/get-media-clips.sdk.json +9 -0
- package/tests/artifacts/get-media-summary.api.json +8 -0
- package/tests/artifacts/get-media-summary.sdk.json +26 -0
- package/tests/artifacts/get-media.api.json +57 -0
- package/tests/artifacts/get-media.sdk.json +57 -0
- package/tests/artifacts/get-playback-id.api.json +19 -0
- package/tests/artifacts/get-playback-id.sdk.json +19 -0
- package/tests/artifacts/get-playlist-by-id.api.json +15 -0
- package/tests/artifacts/get-playlist-by-id.sdk.json +15 -0
- package/tests/artifacts/get-signing_key_by_id.api.json +8 -0
- package/tests/artifacts/get-signing_key_by_id.sdk.json +8 -0
- package/tests/artifacts/get-specific-simulcast-of-stream.api.json +12 -0
- package/tests/artifacts/get-specific-simulcast-of-stream.sdk.json +12 -0
- package/tests/artifacts/getDrmConfiguration.api.json +8 -0
- package/tests/artifacts/getDrmConfiguration.sdk.json +26 -0
- package/tests/artifacts/getDrmConfigurationById.api.json +13 -0
- package/tests/artifacts/getDrmConfigurationById.sdk.json +31 -0
- package/tests/artifacts/get_timeseries_data.api.json +18 -0
- package/tests/artifacts/get_timeseries_data.sdk.json +18 -0
- package/tests/artifacts/get_video_view_details.api.json +213 -0
- package/tests/artifacts/get_video_view_details.sdk.json +213 -0
- package/tests/artifacts/list-live-clips.api.json +9 -0
- package/tests/artifacts/list-live-clips.sdk.json +9 -0
- package/tests/artifacts/list-media.api.json +65 -0
- package/tests/artifacts/list-media.sdk.json +65 -0
- package/tests/artifacts/list-playback-ids.api.json +21 -0
- package/tests/artifacts/list-playback-ids.sdk.json +21 -0
- package/tests/artifacts/list-uploads.api.json +43 -0
- package/tests/artifacts/list-uploads.sdk.json +43 -0
- package/tests/artifacts/list_breakdown_values.api.json +24 -0
- package/tests/artifacts/list_breakdown_values.sdk.json +24 -0
- package/tests/artifacts/list_by_top_content.api.json +19 -0
- package/tests/artifacts/list_by_top_content.sdk.json +19 -0
- package/tests/artifacts/list_comparison_values.api.json +350 -0
- package/tests/artifacts/list_comparison_values.sdk.json +350 -0
- package/tests/artifacts/list_dimensions.api.json +61 -0
- package/tests/artifacts/list_dimensions.sdk.json +61 -0
- package/tests/artifacts/list_errors.api.json +51 -0
- package/tests/artifacts/list_errors.sdk.json +51 -0
- package/tests/artifacts/list_filter_values_for_dimension.api.json +14 -0
- package/tests/artifacts/list_filter_values_for_dimension.sdk.json +14 -0
- package/tests/artifacts/list_overall_values.api.json +18 -0
- package/tests/artifacts/list_overall_values.sdk.json +18 -0
- package/tests/artifacts/list_signing_keys.api.json +22 -0
- package/tests/artifacts/list_signing_keys.sdk.json +22 -0
- package/tests/artifacts/list_video_views.api.json +84 -0
- package/tests/artifacts/list_video_views.sdk.json +84 -0
- package/tests/artifacts/retrieveMediaInputInfo.api.json +28 -0
- package/tests/artifacts/retrieveMediaInputInfo.sdk.json +28 -0
- package/tests/artifacts-non-get/Add-media-track.raw.json +10 -0
- package/tests/artifacts-non-get/Add-media-track.sdk.json +10 -0
- package/tests/artifacts-non-get/Generate-subtitle-track.raw.json +9 -0
- package/tests/artifacts-non-get/Generate-subtitle-track.sdk.json +9 -0
- package/tests/artifacts-non-get/add-media-to-playlist.raw.json +24 -0
- package/tests/artifacts-non-get/add-media-to-playlist.sdk.json +24 -0
- package/tests/artifacts-non-get/cancel-upload.raw.json +15 -0
- package/tests/artifacts-non-get/cancel-upload.sdk.json +15 -0
- package/tests/artifacts-non-get/change-media-order-in-playlist.raw.json +24 -0
- package/tests/artifacts-non-get/change-media-order-in-playlist.sdk.json +24 -0
- package/tests/artifacts-non-get/complete-live-stream.raw.json +8 -0
- package/tests/artifacts-non-get/complete-live-stream.sdk.json +13 -0
- package/tests/artifacts-non-get/create-a-playlist.raw.json +15 -0
- package/tests/artifacts-non-get/create-a-playlist.sdk.json +15 -0
- package/tests/artifacts-non-get/create-media-playback-id.raw.json +20 -0
- package/tests/artifacts-non-get/create-media-playback-id.sdk.json +19 -0
- package/tests/artifacts-non-get/create-media.raw.json +41 -0
- package/tests/artifacts-non-get/create-media.sdk.json +41 -0
- package/tests/artifacts-non-get/create-new-stream.raw.json +32 -0
- package/tests/artifacts-non-get/create-new-stream.sdk.json +32 -0
- package/tests/artifacts-non-get/create-playbackId-of-stream.raw.json +7 -0
- package/tests/artifacts-non-get/create-playbackId-of-stream.sdk.json +7 -0
- package/tests/artifacts-non-get/create-simulcast-of-stream.raw.json +9 -0
- package/tests/artifacts-non-get/create-simulcast-of-stream.sdk.json +9 -0
- package/tests/artifacts-non-get/create_signing_key.raw.json +8 -0
- package/tests/artifacts-non-get/create_signing_key.sdk.json +8 -0
- package/tests/artifacts-non-get/delete-a-playlist.raw.json +3 -0
- package/tests/artifacts-non-get/delete-a-playlist.sdk.json +3 -0
- package/tests/artifacts-non-get/delete-live-stream.raw.json +3 -0
- package/tests/artifacts-non-get/delete-live-stream.sdk.json +3 -0
- package/tests/artifacts-non-get/delete-media-from-playlist.raw.json +15 -0
- package/tests/artifacts-non-get/delete-media-from-playlist.sdk.json +15 -0
- package/tests/artifacts-non-get/delete-media-playback-id.raw.json +3 -0
- package/tests/artifacts-non-get/delete-media-playback-id.sdk.json +3 -0
- package/tests/artifacts-non-get/delete-media-track.raw.json +3 -0
- package/tests/artifacts-non-get/delete-media-track.sdk.json +3 -0
- package/tests/artifacts-non-get/delete-media.raw.json +3 -0
- package/tests/artifacts-non-get/delete-media.sdk.json +3 -0
- package/tests/artifacts-non-get/delete-playbackId-of-stream.raw.json +3 -0
- package/tests/artifacts-non-get/delete-playbackId-of-stream.sdk.json +3 -0
- package/tests/artifacts-non-get/delete-simulcast-of-stream.raw.json +3 -0
- package/tests/artifacts-non-get/delete-simulcast-of-stream.sdk.json +3 -0
- package/tests/artifacts-non-get/delete_signing_key.raw.json +6 -0
- package/tests/artifacts-non-get/delete_signing_key.sdk.json +6 -0
- package/tests/artifacts-non-get/direct-upload-video-media.raw.json +36 -0
- package/tests/artifacts-non-get/direct-upload-video-media.sdk.json +36 -0
- package/tests/artifacts-non-get/disable-live-stream.raw.json +3 -0
- package/tests/artifacts-non-get/disable-live-stream.sdk.json +3 -0
- package/tests/artifacts-non-get/enable-live-stream.raw.json +3 -0
- package/tests/artifacts-non-get/enable-live-stream.sdk.json +3 -0
- package/tests/artifacts-non-get/update-a-playlist.raw.json +15 -0
- package/tests/artifacts-non-get/update-a-playlist.sdk.json +15 -0
- package/tests/artifacts-non-get/update-domain-restrictions.raw.json +10 -0
- package/tests/artifacts-non-get/update-domain-restrictions.sdk.json +10 -0
- package/tests/artifacts-non-get/update-live-stream.raw.json +36 -0
- package/tests/artifacts-non-get/update-live-stream.sdk.json +36 -0
- package/tests/artifacts-non-get/update-media-chapters.raw.json +7 -0
- package/tests/artifacts-non-get/update-media-chapters.sdk.json +7 -0
- package/tests/artifacts-non-get/update-media-moderation.raw.json +7 -0
- package/tests/artifacts-non-get/update-media-moderation.sdk.json +7 -0
- package/tests/artifacts-non-get/update-media-named-entities.raw.json +7 -0
- package/tests/artifacts-non-get/update-media-named-entities.sdk.json +7 -0
- package/tests/artifacts-non-get/update-media-summary.raw.json +7 -0
- package/tests/artifacts-non-get/update-media-summary.sdk.json +7 -0
- package/tests/artifacts-non-get/update-media-track.raw.json +10 -0
- package/tests/artifacts-non-get/update-media-track.sdk.json +10 -0
- package/tests/artifacts-non-get/update-specific-simulcast-of-stream.raw.json +9 -0
- package/tests/artifacts-non-get/update-specific-simulcast-of-stream.sdk.json +9 -0
- package/tests/artifacts-non-get/update-user-agent-restrictions.raw.json +10 -0
- package/tests/artifacts-non-get/update-user-agent-restrictions.sdk.json +10 -0
- package/tests/artifacts-non-get/updated-media.raw.json +94 -0
- package/tests/artifacts-non-get/updated-media.sdk.json +94 -0
- package/tests/artifacts-non-get/updated-mp4Support.raw.json +95 -0
- package/tests/artifacts-non-get/updated-mp4Support.sdk.json +95 -0
- package/tests/artifacts-non-get/updated-source-access.raw.json +94 -0
- package/tests/artifacts-non-get/updated-source-access.sdk.json +94 -0
- package/tests/build-url-mapping-pass2.mjs +77 -0
- package/tests/build-url-mapping.mjs +101 -0
- package/tests/check-broken-links.mjs +89 -0
- package/tests/diff-api-vs-sdk.mjs +94 -0
- package/tests/diff-passed.mjs +99 -0
- package/tests/diff-strict.mjs +81 -0
- package/tests/non-get-endpoints-fixtures.json +328 -0
- package/tests/validate-get-endpoints.ts +16 -5
- package/tests/validate-non-get-endpoints.ts +477 -0
- package/tests/validate-non-get-lifecycle.ts +1093 -0
|
@@ -38,11 +38,11 @@ import { Result } from "../types/fp.js";
|
|
|
38
38
|
* 2. Include the `chapters` parameter in the request body to enable.
|
|
39
39
|
* 3. The response contains the updated media data, confirming the changes made.
|
|
40
40
|
*
|
|
41
|
-
* You can use the <a href="https://docs.fastpix.
|
|
41
|
+
* You can use the <a href="https://docs.fastpix.com/docs/ai-events#videomediaaichaptersready">video.mediaAI.chapters.ready</a> webhook event to track and notify about the chapters generation.
|
|
42
42
|
*
|
|
43
43
|
* **Use case:** This is particularly useful when a user uploads a video and later decides to enable chapters without re-uploading the entire video.
|
|
44
44
|
*
|
|
45
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
45
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/generate-video-chapters">Video chapters</a>
|
|
46
46
|
*/
|
|
47
47
|
export function inVideoAIfeaturesGenerateChapters(
|
|
48
48
|
client: FastpixCore,
|
|
@@ -60,13 +60,13 @@ import { Result } from "../types/fp.js";
|
|
|
60
60
|
*
|
|
61
61
|
* 3. Receive a response containing the unique id for the newly created media item.
|
|
62
62
|
*
|
|
63
|
-
* 4. Use the id in subsequent API calls, such as checking the status of the media with the <a href="https://docs.fastpix.
|
|
63
|
+
* 4. Use the id in subsequent API calls, such as checking the status of the media with the <a href="https://docs.fastpix.com/reference/get-media">Get Media by ID</a> endpoint to determine when the media is ready for playback.
|
|
64
64
|
*
|
|
65
|
-
* 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://docs.fastpix.
|
|
65
|
+
* 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://docs.fastpix.com/docs/media-events#videomediacreated">video.media.created</a>.
|
|
66
66
|
*
|
|
67
|
-
* After processing completes, monitor the events <a href="https://docs.fastpix.
|
|
67
|
+
* After processing completes, monitor the events <a href="https://docs.fastpix.com/docs/media-events#videomediaready">video.media.ready</a> and <a href="https://docs.fastpix.com/docs/media-events#videomediafailed">video.media.failed</a> to track the status of the media file.
|
|
68
68
|
*
|
|
69
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
69
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/upload-videos-from-url">Upload videos from URL</a>
|
|
70
70
|
*/
|
|
71
71
|
export function inputVideoCreate(
|
|
72
72
|
client: FastpixCore,
|
|
@@ -35,7 +35,7 @@ import { Result } from "../types/fp.js";
|
|
|
35
35
|
*
|
|
36
36
|
* > **NOTE**
|
|
37
37
|
* >
|
|
38
|
-
* > This version now supports uploads with no file size limitations and offers faster uploads. The previous endpoint (which had a 500MB size limit) is now deprecated. You can find details in the [changelog](https://docs.fastpix.
|
|
38
|
+
* > This version now supports uploads with no file size limitations and offers faster uploads. The previous endpoint (which had a 500MB size limit) is now deprecated. You can find details in the [changelog](https://docs.fastpix.com/changelog/api-update-direct-upload-media-from-device).
|
|
39
39
|
*
|
|
40
40
|
* #### How it works
|
|
41
41
|
*
|
|
@@ -43,19 +43,19 @@ import { Result } from "../types/fp.js";
|
|
|
43
43
|
*
|
|
44
44
|
* 2. The response includes an `uploadId` and a signed `url` for direct video file upload.
|
|
45
45
|
*
|
|
46
|
-
* 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://docs.fastpix.
|
|
46
|
+
* 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://docs.fastpix.com/docs/upload-videos-directly#step-3-initiate-the-upload">Step 3: Initiate the upload</a> for complete instructions.)
|
|
47
47
|
*
|
|
48
48
|
* 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.
|
|
49
49
|
*
|
|
50
|
-
* After uploading, you can use the <a href="https://docs.fastpix.
|
|
50
|
+
* After uploading, you can use the <a href="https://docs.fastpix.com/reference/get-media">Get Media by ID</a> endpoint to check the status of the uploaded media asset and see if it has transitioned to a `Ready` status for playback.
|
|
51
51
|
*
|
|
52
|
-
* To notify your application about the status of this API request check for the webhooks for <a href="https://docs.fastpix.
|
|
52
|
+
* To notify your application about the status of this API request check for the webhooks for <a href="https://docs.fastpix.com/docs/webhooks-collection#media-related-events">media related events</a>.
|
|
53
53
|
*
|
|
54
54
|
* #### Example
|
|
55
55
|
*
|
|
56
56
|
* A social media platform allows users to upload video content directly from their phones or computers. This endpoint facilitates the upload process. For example, if you are developing a video-sharing app where users can upload short clips from their mobile devices, this endpoint enables them to select a video, upload it to the platform.
|
|
57
57
|
*
|
|
58
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
58
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/upload-videos-directly">Upload videos directly</a>
|
|
59
59
|
*/
|
|
60
60
|
export function inputVideoUpload(
|
|
61
61
|
client: FastpixCore,
|
|
@@ -32,7 +32,7 @@ import { Result } from "../types/fp.js";
|
|
|
32
32
|
* Create a new stream
|
|
33
33
|
*
|
|
34
34
|
* @remarks
|
|
35
|
-
* Creates a new <a href="https://docs.fastpix.
|
|
35
|
+
* Creates a new <a href="https://docs.fastpix.com/docs/get-started-with-live-streaming">RTMPS</a> or <a href="https://docs.fastpix.com/docs/using-srt-to-live-stream">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.
|
|
36
36
|
*
|
|
37
37
|
* 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.
|
|
38
38
|
*
|
|
@@ -42,13 +42,13 @@ import { Result } from "../types/fp.js";
|
|
|
42
42
|
*
|
|
43
43
|
* 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.
|
|
44
44
|
*
|
|
45
|
-
* 3. After the live stream is created, FastPix sends a `POST` request to your specified webhook endpoint with the event <a href="https://docs.fastpix.
|
|
45
|
+
* 3. After the live stream is created, FastPix sends a `POST` request to your specified webhook endpoint with the event <a href="https://docs.fastpix.com/docs/live-events#videolive_streamcreated">video.live_stream.created</a>.
|
|
46
46
|
*
|
|
47
47
|
* **Example:**
|
|
48
48
|
*
|
|
49
49
|
* 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.
|
|
50
50
|
*
|
|
51
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
51
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/how-to-livestream">How to live stream</a>
|
|
52
52
|
*/
|
|
53
53
|
export function liveStreamsCreate(
|
|
54
54
|
client: FastpixCore,
|
|
@@ -33,13 +33,13 @@ import { Result } from "../types/fp.js";
|
|
|
33
33
|
* @remarks
|
|
34
34
|
* 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.
|
|
35
35
|
*
|
|
36
|
-
* 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://docs.fastpix.
|
|
36
|
+
* 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://docs.fastpix.com/docs/live-events#videolive_streamdeleted">video.live_stream.deleted</a> webhook to notify your system about the status.
|
|
37
37
|
*
|
|
38
38
|
* #### Example
|
|
39
39
|
*
|
|
40
40
|
* 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.
|
|
41
41
|
*
|
|
42
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
42
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/manage-streams">Manage streams</a>
|
|
43
43
|
*/
|
|
44
44
|
export function liveStreamsDelete(
|
|
45
45
|
client: FastpixCore,
|
|
@@ -41,7 +41,7 @@ import { Result } from "../types/fp.js";
|
|
|
41
41
|
*
|
|
42
42
|
* 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.
|
|
43
43
|
*
|
|
44
|
-
* Related guide <a href="https://docs.fastpix.
|
|
44
|
+
* Related guide <a href="https://docs.fastpix.com/docs/manage-streams">Manage streams</a>
|
|
45
45
|
*/
|
|
46
46
|
export function liveStreamsEnable(
|
|
47
47
|
client: FastpixCore,
|
|
@@ -42,7 +42,7 @@ import { Result } from "../types/fp.js";
|
|
|
42
42
|
* #### Use case
|
|
43
43
|
* 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.
|
|
44
44
|
*
|
|
45
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
45
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/instant-live-clipping">Instant live clipping</a>
|
|
46
46
|
*/
|
|
47
47
|
export function liveStreamsListClips(
|
|
48
48
|
client: FastpixCore,
|
|
@@ -41,7 +41,7 @@ import { Result } from "../types/fp.js";
|
|
|
41
41
|
*
|
|
42
42
|
* 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.
|
|
43
43
|
*
|
|
44
|
-
* Related guide <a href="https://docs.fastpix.
|
|
44
|
+
* Related guide <a href="https://docs.fastpix.com/docs/manage-streams">Manage streams</a>
|
|
45
45
|
*/
|
|
46
46
|
export function manageLiveStreamComplete(
|
|
47
47
|
client: FastpixCore,
|
|
@@ -39,7 +39,7 @@ import { Result } from "../types/fp.js";
|
|
|
39
39
|
*
|
|
40
40
|
* 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).
|
|
41
41
|
*
|
|
42
|
-
* Related guide <a href="https://docs.fastpix.
|
|
42
|
+
* Related guide <a href="https://docs.fastpix.com/docs/manage-streams">Manage streams</a>
|
|
43
43
|
*/
|
|
44
44
|
export function manageLiveStreamDisable(
|
|
45
45
|
client: FastpixCore,
|
|
@@ -36,7 +36,7 @@ import { Result } from "../types/fp.js";
|
|
|
36
36
|
*
|
|
37
37
|
* 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.
|
|
38
38
|
*
|
|
39
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
39
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/manage-streams">Manage streams</a>
|
|
40
40
|
*/
|
|
41
41
|
export function manageLiveStreamGet(
|
|
42
42
|
client: FastpixCore,
|
|
@@ -39,7 +39,7 @@ import { Result } from "../types/fp.js";
|
|
|
39
39
|
*
|
|
40
40
|
* 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.
|
|
41
41
|
*
|
|
42
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
42
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/manage-streams">Manage streams</a>
|
|
43
43
|
*/
|
|
44
44
|
export function manageLiveStreamGetViewerCount(
|
|
45
45
|
client: FastpixCore,
|
|
@@ -33,13 +33,13 @@ import { Result } from "../types/fp.js";
|
|
|
33
33
|
* @remarks
|
|
34
34
|
* 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.
|
|
35
35
|
*
|
|
36
|
-
* 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://docs.fastpix.
|
|
36
|
+
* 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://docs.fastpix.com/docs/live-events#videolive_streamupdated">video.live_stream.updated</a> webhook event notifies your system.
|
|
37
37
|
*
|
|
38
38
|
* #### Example
|
|
39
39
|
*
|
|
40
40
|
* 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.
|
|
41
41
|
*
|
|
42
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
42
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/manage-streams">Manage streams</a>
|
|
43
43
|
*/
|
|
44
44
|
export function manageLiveStreamUpdate(
|
|
45
45
|
client: FastpixCore,
|
|
@@ -43,16 +43,16 @@ import { Result } from "../types/fp.js";
|
|
|
43
43
|
*
|
|
44
44
|
* #### Webhook events
|
|
45
45
|
*
|
|
46
|
-
* 1. After successfully adding a track, your system must receive the webhook event <a href="https://docs.fastpix.
|
|
46
|
+
* 1. After successfully adding a track, your system must receive the webhook event <a href="https://docs.fastpix.com/docs/transform-media-events#videomediatrackcreated">video.media.track.created</a>.
|
|
47
47
|
*
|
|
48
|
-
* 2. Once the track is processed and ready, you must receive the webhook event <a href="https://docs.fastpix.
|
|
48
|
+
* 2. Once the track is processed and ready, you must receive the webhook event <a href="https://docs.fastpix.com/docs/transform-media-events#videomediatrackready">video.media.track.ready</a>.
|
|
49
49
|
*
|
|
50
|
-
* 3. Finally, an update event <a href="https://docs.fastpix.
|
|
50
|
+
* 3. Finally, an update event <a href="https://docs.fastpix.com/docs/media-events#videomediaupdated">video.media.updated</a> must notify your system about the media's updated status.
|
|
51
51
|
*
|
|
52
52
|
* #### Example
|
|
53
|
-
* 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.
|
|
53
|
+
* 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`.
|
|
54
54
|
*
|
|
55
|
-
* Related guides: <a href="https://docs.fastpix.
|
|
55
|
+
* Related guides: <a href="https://docs.fastpix.com/docs/manage-subtitle-tracks">Add own subtitle tracks</a>, <a href="https://docs.fastpix.com/docs/manage-audio-tracks">Add own audio tracks</a>
|
|
56
56
|
*/
|
|
57
57
|
export function manageVideosAddTrack(
|
|
58
58
|
client: FastpixCore,
|
|
@@ -40,7 +40,7 @@ import { Result } from "../types/fp.js";
|
|
|
40
40
|
*
|
|
41
41
|
* #### Webhook Events
|
|
42
42
|
*
|
|
43
|
-
* Once the upload is cancelled, you must receive the webhook event <a href="https://docs.fastpix.
|
|
43
|
+
* Once the upload is cancelled, you must receive the webhook event <a href="https://docs.fastpix.com/docs/media-events#videomediauploadcancelled">video.media.upload.cancelled</a>.
|
|
44
44
|
*
|
|
45
45
|
* #### Example
|
|
46
46
|
*
|
|
@@ -39,7 +39,7 @@ import { Result } from "../types/fp.js";
|
|
|
39
39
|
*
|
|
40
40
|
* 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.
|
|
41
41
|
*
|
|
42
|
-
* 3. Monitor the following webhook event: <a href="https://docs.fastpix.
|
|
42
|
+
* 3. Monitor the following webhook event: <a href="https://docs.fastpix.com/docs/media-events#videomediadeleted">video.media.deleted</a>
|
|
43
43
|
*
|
|
44
44
|
* #### Example
|
|
45
45
|
* 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.
|
|
@@ -43,11 +43,11 @@ import { Result } from "../types/fp.js";
|
|
|
43
43
|
*
|
|
44
44
|
* #### Webhook Events
|
|
45
45
|
*
|
|
46
|
-
* 1. After the subtitle track is generated and ready, you receive the webhook event <a href="https://docs.fastpix.
|
|
46
|
+
* 1. After the subtitle track is generated and ready, you receive the webhook event <a href="https://docs.fastpix.com/docs/transform-media-events#videomediasubtitlegeneratedready">video.media.subtitle.generated.ready</a>.
|
|
47
47
|
*
|
|
48
|
-
* 2. Finally the <a href="https://docs.fastpix.
|
|
48
|
+
* 2. Finally the <a href="https://docs.fastpix.com/docs/media-events#videomediaupdated">video.media.updated</a> event notifies your system about the media’s updated status.
|
|
49
49
|
*
|
|
50
|
-
* </br> Related guide: <a href="https://docs.fastpix.
|
|
50
|
+
* </br> Related guide: <a href="https://docs.fastpix.com/docs/add-auto-generated-subtitles-to-videos">Add auto-generated subtitles</a>
|
|
51
51
|
*/
|
|
52
52
|
export function manageVideosGenerateSubtitleTrack(
|
|
53
53
|
client: FastpixCore,
|
|
@@ -41,7 +41,7 @@ import { Result } from "../types/fp.js";
|
|
|
41
41
|
* - **status** – Indicates whether the media is still *Processing* or has transitioned to *Ready*.
|
|
42
42
|
* - **playbackId** – A unique identifier that allows you to stream the media once it is *Ready*.
|
|
43
43
|
* You can construct the stream URL as follows:
|
|
44
|
-
* `https://stream.fastpix.
|
|
44
|
+
* `https://stream.fastpix.com/<playbackId>.m3u8`
|
|
45
45
|
*
|
|
46
46
|
* #### Example
|
|
47
47
|
*
|
|
@@ -41,7 +41,7 @@ import { Result } from "../types/fp.js";
|
|
|
41
41
|
*
|
|
42
42
|
* 3. The response returns the updated media data, confirming the changes.
|
|
43
43
|
*
|
|
44
|
-
* 4. Monitor the <a href="https://docs.fastpix.
|
|
44
|
+
* 4. Monitor the <a href="https://docs.fastpix.com/docs/media-events#videomediaupdated">video.media.updated</a> webhook event to track the update status in your system.
|
|
45
45
|
*
|
|
46
46
|
* #### Example
|
|
47
47
|
* 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.
|
|
@@ -53,12 +53,12 @@ import { Result } from "../types/fp.js";
|
|
|
53
53
|
*
|
|
54
54
|
* #### Webhook events
|
|
55
55
|
*
|
|
56
|
-
* - <a href="https://docs.fastpix.
|
|
56
|
+
* - <a href="https://docs.fastpix.com/docs/transform-media-events#videomediamp4supportready">video.media.mp4Support.ready</a> – Triggered when the MP4 support setting is successfully updated.
|
|
57
57
|
*
|
|
58
58
|
* #### Example
|
|
59
|
-
* 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.
|
|
59
|
+
* 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.
|
|
60
60
|
*
|
|
61
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
61
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/mp4-support-for-offline-viewing">Use MP4 support for offline viewing</a>
|
|
62
62
|
*/
|
|
63
63
|
export function manageVideosUpdateMp4Support(
|
|
64
64
|
client: FastpixCore,
|
|
@@ -45,11 +45,11 @@ import { Result } from "../types/fp.js";
|
|
|
45
45
|
*
|
|
46
46
|
* After updating a track, your system must receive webhook notifications:
|
|
47
47
|
*
|
|
48
|
-
* 1. After successfully updating a track, your system must receive the webhook event <a href="https://docs.fastpix.
|
|
48
|
+
* 1. After successfully updating a track, your system must receive the webhook event <a href="https://docs.fastpix.com/docs/transform-media-events#videomediatrackupdated">video.media.track.updated</a>.
|
|
49
49
|
*
|
|
50
|
-
* 2. Once the new track is processed and ready, you must receive the webhook event <a href="https://docs.fastpix.
|
|
50
|
+
* 2. Once the new track is processed and ready, you must receive the webhook event <a href="https://docs.fastpix.com/docs/transform-media-events#videomediatrackready">video.media.track.ready</a>.
|
|
51
51
|
*
|
|
52
|
-
* 3. Once the media file is updated with the new track details, a <a href="https://docs.fastpix.
|
|
52
|
+
* 3. Once the media file is updated with the new track details, a <a href="https://docs.fastpix.com/docs/media-events#videomediaupdated">video.media.updated</a> event must be triggered.
|
|
53
53
|
*
|
|
54
54
|
* #### Example
|
|
55
55
|
* Suppose you previously added a French subtitle track to a video but now need to update it with a different file. By calling this API, you can replace the existing subtitle file (.vtt) with a new one while keeping the same track ID. This is useful when:
|
|
@@ -57,7 +57,7 @@ import { Result } from "../types/fp.js";
|
|
|
57
57
|
* - The original track file has errors and needs correction.
|
|
58
58
|
* - You want to improve subtitle translations or replace an audio track with a better-quality version.
|
|
59
59
|
*
|
|
60
|
-
* Related guides: <a href="https://docs.fastpix.
|
|
60
|
+
* Related guides: <a href="https://docs.fastpix.com/docs/manage-subtitle-tracks">Add own subtitle tracks</a>, <a href="https://docs.fastpix.com/docs/manage-audio-tracks">Add own audio tracks</a>
|
|
61
61
|
*/
|
|
62
62
|
export function manageVideosUpdateTrack(
|
|
63
63
|
client: FastpixCore,
|
|
@@ -43,7 +43,7 @@ import { Result } from "../types/fp.js";
|
|
|
43
43
|
*
|
|
44
44
|
* 1. After successfully deleting a track, your system must receive the webhook event **video.media.track.deleted**.
|
|
45
45
|
*
|
|
46
|
-
* 2. Once the media file is updated to reflect the track removal, a <a href="https://docs.fastpix.
|
|
46
|
+
* 2. Once the media file is updated to reflect the track removal, a <a href="https://docs.fastpix.com/docs/media-events#videomediaupdated">video.media.updated</a> event must be triggered.
|
|
47
47
|
*
|
|
48
48
|
* #### Example
|
|
49
49
|
* Suppose you uploaded an audio track in Italian for a video but later realize it's incorrect or no longer needed. By calling this API, you can remove the specific track while keeping the rest of the media file unchanged. This is useful when:
|
|
@@ -52,7 +52,7 @@ import { Result } from "../types/fp.js";
|
|
|
52
52
|
* - The content owner requests the removal of a specific subtitle or audio track.
|
|
53
53
|
* - A new version of the track gets uploaded to replace the existing one.
|
|
54
54
|
*
|
|
55
|
-
* Related guides: <a href="https://docs.fastpix.
|
|
55
|
+
* Related guides: <a href="https://docs.fastpix.com/docs/manage-subtitle-tracks">Add own subtitle tracks</a>, <a href="https://docs.fastpix.com/docs/manage-audio-tracks">Add own audio tracks</a>
|
|
56
56
|
*/
|
|
57
57
|
export function mediaDeleteTrack(
|
|
58
58
|
client: FastpixCore,
|
|
@@ -46,7 +46,7 @@ import { Result } from "../types/fp.js";
|
|
|
46
46
|
*
|
|
47
47
|
* 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.
|
|
48
48
|
*
|
|
49
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
49
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/create-clips-from-existing-media">Create clips from existing media</a>
|
|
50
50
|
*/
|
|
51
51
|
export function mediaGetClips(
|
|
52
52
|
client: FastpixCore,
|
|
@@ -40,7 +40,7 @@ import { Result } from "../types/fp.js";
|
|
|
40
40
|
* 2. Include the updated `sourceAccess` parameter in the request body.
|
|
41
41
|
*
|
|
42
42
|
* 3. You receive a response confirming the update to the media’s source access status.
|
|
43
|
-
* 4. Webhook events: <a href="https://docs.fastpix.
|
|
43
|
+
* 4. Webhook events: <a href="https://docs.fastpix.com/docs/transform-media-events#videomediasourceready">video.media.source.ready</a>, <a href="https://docs.fastpix.com/docs/transform-media-events#videomediasourcedeleted">video.media.source.deleted</a>
|
|
44
44
|
*/
|
|
45
45
|
export function mediaUpdateSourceAccess(
|
|
46
46
|
client: FastpixCore,
|
|
@@ -35,7 +35,7 @@ import { Result } from "../types/fp.js";
|
|
|
35
35
|
*
|
|
36
36
|
* #### How it works
|
|
37
37
|
*
|
|
38
|
-
* 1. Before using this endpoint, you can call the <a href="https://docs.fastpix.
|
|
38
|
+
* 1. Before using this endpoint, you can call the <a href="https://docs.fastpix.com/reference/list_dimensions">List Dimensions</a> endpoint to retrieve all available dimensions that can be used in your query.
|
|
39
39
|
*
|
|
40
40
|
* 2. Send a `GET` request to this endpoint with the required `metricId` and other query parameters.
|
|
41
41
|
*
|
|
@@ -57,7 +57,7 @@ import { Result } from "../types/fp.js";
|
|
|
57
57
|
* * **totalPlayTime:** Total time spent playing the video, represented in milliseconds.
|
|
58
58
|
* * **field:** The grouping field value based on the groupBy parameter.
|
|
59
59
|
*
|
|
60
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
60
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/metrics-overview">Understand data definitions</a>
|
|
61
61
|
*/
|
|
62
62
|
export function metricsListBreakdownValues(
|
|
63
63
|
client: FastpixCore,
|
|
@@ -44,13 +44,13 @@ import { Result } from "../types/fp.js";
|
|
|
44
44
|
*
|
|
45
45
|
* #### How it works
|
|
46
46
|
*
|
|
47
|
-
* 1. Before making a request to this endpoint, call the <a href="https://docs.fastpix.
|
|
47
|
+
* 1. Before making a request to this endpoint, call the <a href="https://docs.fastpix.com/reference/list_dimensions">list dimensions</a> endpoint to obtain all available dimensions that can be used for comparison.
|
|
48
48
|
*
|
|
49
49
|
* 2. Send a `GET` request to this endpoint with the desired metrics specified in the query parameters.
|
|
50
50
|
*
|
|
51
51
|
* 3. You Receive a response containing the comparison values for the specified metrics across the selected dimensions.
|
|
52
52
|
*
|
|
53
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
53
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/understand-dashboard-ui#compare-metrics">Compare metrics in dashboard</a>
|
|
54
54
|
*/
|
|
55
55
|
export function metricsListCompares(
|
|
56
56
|
client: FastpixCore,
|
|
@@ -35,7 +35,7 @@ import { Result } from "../types/fp.js";
|
|
|
35
35
|
*
|
|
36
36
|
* #### How it works
|
|
37
37
|
*
|
|
38
|
-
* 1. Before using this endpoint, you can call the <a href="https://docs.fastpix.
|
|
38
|
+
* 1. Before using this endpoint, you can call the <a href="https://docs.fastpix.com/reference/list_dimensions">list dimensions</a> endpoint to retrieve all available dimensions that can be used in your query.
|
|
39
39
|
*
|
|
40
40
|
* 2. Send a `GET` request to this endpoint with the required `metricId` and other query parameters.
|
|
41
41
|
*
|
|
@@ -50,7 +50,7 @@ import { Result } from "../types/fp.js";
|
|
|
50
50
|
* * **totalPlayTime:** Total time spent playing the video, represented in milliseconds.
|
|
51
51
|
* * **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.
|
|
52
52
|
*
|
|
53
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
53
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/metrics-overview">Understand data definitions</a>
|
|
54
54
|
*/
|
|
55
55
|
export function metricsListOverallValues(
|
|
56
56
|
client: FastpixCore,
|
|
@@ -31,7 +31,7 @@ import { Result } from "../types/fp.js";
|
|
|
31
31
|
* Create a playback ID
|
|
32
32
|
*
|
|
33
33
|
* @remarks
|
|
34
|
-
* 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://docs.fastpix.
|
|
34
|
+
* 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://docs.fastpix.com/reference/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.
|
|
35
35
|
*
|
|
36
36
|
* If you want to create a private playback ID for a media asset that already has a public playback ID, this endpoint also allows you to do so by specifying the desired access policy.
|
|
37
37
|
*
|
|
@@ -37,7 +37,7 @@ import { Result } from "../types/fp.js";
|
|
|
37
37
|
* - **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.
|
|
38
38
|
* - **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.
|
|
39
39
|
*
|
|
40
|
-
* For more details, see <a href="https://docs.fastpix.
|
|
40
|
+
* For more details, see <a href="https://docs.fastpix.com/docs/create-and-manage-playlist">Create and manage playlist</a>.
|
|
41
41
|
*
|
|
42
42
|
* #### How it works
|
|
43
43
|
*
|
|
@@ -43,7 +43,7 @@ import { Result } from "../types/fp.js";
|
|
|
43
43
|
* **Use case:** A developer building a video subscription service wants to ensure that only authorized users can access premium content. By generating a signing key, the developer can issue signed JSON Web Tokens (JWTs) to authenticate and authorize users. These tokens can be validated by FastPix using the stored public key.
|
|
44
44
|
*
|
|
45
45
|
* **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/>
|
|
46
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
46
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/secure-playback-with-jwts">Create and use signing keys</a>
|
|
47
47
|
*/
|
|
48
48
|
export function signingKeysCreate(
|
|
49
49
|
client: FastpixCore,
|
|
@@ -43,7 +43,7 @@ import { Result } from "../types/fp.js";
|
|
|
43
43
|
* {
|
|
44
44
|
* "kid": "359302ee-2446-4afe-9348-8b4656b9ddb1",
|
|
45
45
|
* "aud": "media:6cee6f85-9334-4a51-9ce3-e0241d94ceef",
|
|
46
|
-
* "iss": "fastpix.
|
|
46
|
+
* "iss": "fastpix.com",
|
|
47
47
|
* "sub": "",
|
|
48
48
|
* "iat": 1706703204,
|
|
49
49
|
* "exp": 1735626783
|
|
@@ -53,7 +53,7 @@ import { Result } from "../types/fp.js";
|
|
|
53
53
|
*
|
|
54
54
|
* * **kid:** The key ID of the signing key.
|
|
55
55
|
* * **aud:** The audience for which the token is intended, enter the playbackId here.
|
|
56
|
-
* * **iss:** The issuer of the token (for example, "fastpix.
|
|
56
|
+
* * **iss:** The issuer of the token (for example, "fastpix.com ").
|
|
57
57
|
* * **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.
|
|
58
58
|
* * **groups:** An array of groups the subject belongs to (for example, ["user"]).
|
|
59
59
|
* * **iat:** The issued-at timestamp, indicating when the token was created.
|
|
@@ -33,7 +33,7 @@ import { Result } from "../types/fp.js";
|
|
|
33
33
|
* @remarks
|
|
34
34
|
* 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.
|
|
35
35
|
*
|
|
36
|
-
* Webhook event: <a href="https://docs.fastpix.
|
|
36
|
+
* Webhook event: <a href="https://docs.fastpix.com/docs/live-events#videolive_streamsimulcast_targetdeleted">video.live_stream.simulcast_target.deleted</a>
|
|
37
37
|
*
|
|
38
38
|
* #### Example
|
|
39
39
|
* A broadcaster may need to stop simulcasting to one platform while keeping the stream active on others. For example, a tech company is simulcasting a product launch across multiple platforms. Midway through the event, they decide to stop the simulcast on Facebook due to performance issues but continue streaming on YouTube. They use this API to delete the Facebook simulcast target.
|
|
@@ -36,12 +36,12 @@ import { Result } from "../types/fp.js";
|
|
|
36
36
|
*
|
|
37
37
|
* 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.
|
|
38
38
|
*
|
|
39
|
-
* 2. To notify your application about the status of simulcast related events check for the <a href="https://docs.fastpix.
|
|
39
|
+
* 2. To notify your application about the status of simulcast related events check for the <a href="https://docs.fastpix.com/docs/webhooks-collection#simulcast-target-events">webhooks for simulcast</a> target events.
|
|
40
40
|
*
|
|
41
41
|
* #### Example
|
|
42
42
|
* 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.
|
|
43
43
|
*
|
|
44
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
44
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/simulcast-to-3rd-party-platforms">Simulcast to 3rd party platforms</a>
|
|
45
45
|
*/
|
|
46
46
|
export function simulcastsCreate(
|
|
47
47
|
client: FastpixCore,
|
|
@@ -33,7 +33,7 @@ import { Result } from "../types/fp.js";
|
|
|
33
33
|
* @remarks
|
|
34
34
|
* 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.
|
|
35
35
|
*
|
|
36
|
-
* Webhook event: <a href="https://docs.fastpix.
|
|
36
|
+
* Webhook event: <a href="https://docs.fastpix.com/docs/live-events#videolive_streamsimulcast_targetupdated">video.live_stream.simulcast_target.updated</a>
|
|
37
37
|
*
|
|
38
38
|
* #### Example
|
|
39
39
|
* 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.
|
|
@@ -39,7 +39,7 @@ import { Result } from "../types/fp.js";
|
|
|
39
39
|
*
|
|
40
40
|
* 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.
|
|
41
41
|
*
|
|
42
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
42
|
+
* Related guide: <a href="https://docs.fastpix.com/page/what-video-data-do-we-capture#/">What Video Data do we capture?</a>
|
|
43
43
|
*/
|
|
44
44
|
export function viewsGetDetails(
|
|
45
45
|
client: FastpixCore,
|
package/src/funcs/viewsList.ts
CHANGED
|
@@ -39,7 +39,7 @@ import { Result } from "../types/fp.js";
|
|
|
39
39
|
*
|
|
40
40
|
* 2. Specify the timespan for which you want to retrieve the video views using the `timespan[]` parameter.
|
|
41
41
|
*
|
|
42
|
-
* 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://docs.fastpix.
|
|
42
|
+
* 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://docs.fastpix.com/reference/list_dimensions">list the dimensions</a> endpoint.
|
|
43
43
|
*
|
|
44
44
|
* 4. Paginate the results using the `limit` and `offset` parameters.
|
|
45
45
|
*
|
|
@@ -47,13 +47,13 @@ import { Result } from "../types/fp.js";
|
|
|
47
47
|
*
|
|
48
48
|
* 6. You receive a response containing the list of video views matching the specified criteria.
|
|
49
49
|
*
|
|
50
|
-
* Each view in the response includes a unique `viewId`. You can use this `viewId` with the <a href="https://docs.fastpix.
|
|
50
|
+
* Each view in the response includes a unique `viewId`. You can use this `viewId` with the <a href="https://docs.fastpix.com/reference/get_video_view_details">Get Video View Details</a> endpoint to retrieve more detailed information about that specific view.
|
|
51
51
|
*
|
|
52
52
|
* #### Example
|
|
53
53
|
*
|
|
54
54
|
* 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.
|
|
55
55
|
*
|
|
56
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
56
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/audience-metrics">Audience metrics</a>, <a href="https://docs.fastpix.com/docs/understand-dashboard-ui#1-views-dashboard">Views dashboard</a>
|
|
57
57
|
*/
|
|
58
58
|
export function viewsList(
|
|
59
59
|
client: FastpixCore,
|
|
@@ -45,7 +45,7 @@ import { Result } from "../types/fp.js";
|
|
|
45
45
|
*
|
|
46
46
|
* 5. You receive a response containing the list of top video views matching the specified criteria.
|
|
47
47
|
*
|
|
48
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
48
|
+
* Related guide: <a href="https://docs.fastpix.com/page/how-to-get-top-performing-content">Get top-performing content</a>
|
|
49
49
|
*/
|
|
50
50
|
export function viewsListTopContent(
|
|
51
51
|
client: FastpixCore,
|
package/src/lib/config.ts
CHANGED
|
@@ -59,7 +59,7 @@ export const AddTrackRequest$outboundSchema: z.ZodMiniType<
|
|
|
59
59
|
AddTrackRequest$Outbound,
|
|
60
60
|
AddTrackRequest
|
|
61
61
|
> = z.object({
|
|
62
|
-
url: z._default(z.string(), "https://static.fastpix.
|
|
62
|
+
url: z._default(z.string(), "https://static.fastpix.com/music-1.mp3"),
|
|
63
63
|
type: z._default(AddTrackRequestType$outboundSchema, "audio"),
|
|
64
64
|
languageCode: z._default(z.string(), "it"),
|
|
65
65
|
languageName: z._default(z.string(), "Italian"),
|