@fastpix/fastpix-node 2.0.4 → 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/hooks/eventsFieldRemapHook.d.ts +5 -0
- package/dist/commonjs/hooks/eventsFieldRemapHook.d.ts.map +1 -0
- package/dist/commonjs/hooks/eventsFieldRemapHook.js +84 -0
- package/dist/commonjs/hooks/eventsFieldRemapHook.js.map +1 -0
- package/dist/commonjs/hooks/registration.d.ts.map +1 -1
- package/dist/commonjs/hooks/registration.js +2 -4
- package/dist/commonjs/hooks/registration.js.map +1 -1
- package/dist/commonjs/lib/config.d.ts +3 -3
- package/dist/commonjs/lib/config.d.ts.map +1 -1
- package/dist/commonjs/lib/config.js +3 -3
- 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 +4 -9
- 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/hooks/eventsFieldRemapHook.d.ts +5 -0
- package/dist/esm/hooks/eventsFieldRemapHook.d.ts.map +1 -0
- package/dist/esm/hooks/eventsFieldRemapHook.js +80 -0
- package/dist/esm/hooks/eventsFieldRemapHook.js.map +1 -0
- package/dist/esm/hooks/registration.d.ts.map +1 -1
- package/dist/esm/hooks/registration.js +2 -4
- package/dist/esm/hooks/registration.js.map +1 -1
- package/dist/esm/lib/config.d.ts +3 -3
- package/dist/esm/lib/config.d.ts.map +1 -1
- package/dist/esm/lib/config.js +3 -3
- 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 +4 -9
- 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/examples/package-lock.json +1 -1
- package/jsr.json +1 -1
- package/package.json +10 -4
- 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/hooks/eventsFieldRemapHook.ts +94 -0
- package/src/hooks/registration.ts +2 -4
- package/src/lib/config.ts +3 -3
- 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 +7 -19
- 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
|
@@ -31,7 +31,7 @@ export declare class Media extends ClientSDK {
|
|
|
31
31
|
*
|
|
32
32
|
* 1. After successfully deleting a track, your system must receive the webhook event **video.media.track.deleted**.
|
|
33
33
|
*
|
|
34
|
-
* 2. Once the media file is updated to reflect the track removal, a <a href="https://docs.fastpix.
|
|
34
|
+
* 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.
|
|
35
35
|
*
|
|
36
36
|
* #### Example
|
|
37
37
|
* 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:
|
|
@@ -40,7 +40,7 @@ export declare class Media extends ClientSDK {
|
|
|
40
40
|
* - The content owner requests the removal of a specific subtitle or audio track.
|
|
41
41
|
* - A new version of the track gets uploaded to replace the existing one.
|
|
42
42
|
*
|
|
43
|
-
* Related guides: <a href="https://docs.fastpix.
|
|
43
|
+
* 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>
|
|
44
44
|
*/
|
|
45
45
|
deleteTrack(request: operations.DeleteMediaTrackRequest, options?: RequestOptions): Promise<operations.DeleteMediaTrackResponse>;
|
|
46
46
|
/**
|
|
@@ -56,7 +56,7 @@ export declare class Media extends ClientSDK {
|
|
|
56
56
|
* 2. Include the updated `sourceAccess` parameter in the request body.
|
|
57
57
|
*
|
|
58
58
|
* 3. You receive a response confirming the update to the media’s source access status.
|
|
59
|
-
* 4. Webhook events: <a href="https://docs.fastpix.
|
|
59
|
+
* 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>
|
|
60
60
|
*/
|
|
61
61
|
updateSourceAccess(request: operations.UpdatedSourceAccessRequest, options?: RequestOptions): Promise<operations.UpdatedSourceAccessResponse>;
|
|
62
62
|
/**
|
|
@@ -78,7 +78,7 @@ export declare class Media extends ClientSDK {
|
|
|
78
78
|
*
|
|
79
79
|
* 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.
|
|
80
80
|
*
|
|
81
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
81
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/create-clips-from-existing-media">Create clips from existing media</a>
|
|
82
82
|
*/
|
|
83
83
|
getClips(request: operations.GetMediaClipsRequest, options?: RequestOptions): Promise<operations.GetMediaClipsResponse>;
|
|
84
84
|
}
|
|
@@ -45,7 +45,7 @@ class Media extends sdks_js_1.ClientSDK {
|
|
|
45
45
|
*
|
|
46
46
|
* 1. After successfully deleting a track, your system must receive the webhook event **video.media.track.deleted**.
|
|
47
47
|
*
|
|
48
|
-
* 2. Once the media file is updated to reflect the track removal, a <a href="https://docs.fastpix.
|
|
48
|
+
* 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.
|
|
49
49
|
*
|
|
50
50
|
* #### Example
|
|
51
51
|
* 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:
|
|
@@ -54,7 +54,7 @@ class Media extends sdks_js_1.ClientSDK {
|
|
|
54
54
|
* - The content owner requests the removal of a specific subtitle or audio track.
|
|
55
55
|
* - A new version of the track gets uploaded to replace the existing one.
|
|
56
56
|
*
|
|
57
|
-
* Related guides: <a href="https://docs.fastpix.
|
|
57
|
+
* 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>
|
|
58
58
|
*/
|
|
59
59
|
async deleteTrack(request, options) {
|
|
60
60
|
return (0, fp_js_1.unwrapAsync)((0, mediaDeleteTrack_js_1.mediaDeleteTrack)(this, request, options));
|
|
@@ -72,7 +72,7 @@ class Media extends sdks_js_1.ClientSDK {
|
|
|
72
72
|
* 2. Include the updated `sourceAccess` parameter in the request body.
|
|
73
73
|
*
|
|
74
74
|
* 3. You receive a response confirming the update to the media’s source access status.
|
|
75
|
-
* 4. Webhook events: <a href="https://docs.fastpix.
|
|
75
|
+
* 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>
|
|
76
76
|
*/
|
|
77
77
|
async updateSourceAccess(request, options) {
|
|
78
78
|
return (0, fp_js_1.unwrapAsync)((0, mediaUpdateSourceAccess_js_1.mediaUpdateSourceAccess)(this, request, options));
|
|
@@ -96,7 +96,7 @@ class Media extends sdks_js_1.ClientSDK {
|
|
|
96
96
|
*
|
|
97
97
|
* 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.
|
|
98
98
|
*
|
|
99
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
99
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/create-clips-from-existing-media">Create clips from existing media</a>
|
|
100
100
|
*/
|
|
101
101
|
async getClips(request, options) {
|
|
102
102
|
return (0, fp_js_1.unwrapAsync)((0, mediaGetClips_js_1.mediaGetClips)(this, request, options));
|
|
@@ -9,7 +9,7 @@ export declare class Metrics extends ClientSDK {
|
|
|
9
9
|
*
|
|
10
10
|
* #### How it works
|
|
11
11
|
*
|
|
12
|
-
* 1. Before using this endpoint, you can call the <a href="https://docs.fastpix.
|
|
12
|
+
* 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.
|
|
13
13
|
*
|
|
14
14
|
* 2. Send a `GET` request to this endpoint with the required `metricId` and other query parameters.
|
|
15
15
|
*
|
|
@@ -31,7 +31,7 @@ export declare class Metrics extends ClientSDK {
|
|
|
31
31
|
* * **totalPlayTime:** Total time spent playing the video, represented in milliseconds.
|
|
32
32
|
* * **field:** The grouping field value based on the groupBy parameter.
|
|
33
33
|
*
|
|
34
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
34
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/metrics-overview">Understand data definitions</a>
|
|
35
35
|
*/
|
|
36
36
|
listBreakdownValues(request: operations.ListBreakdownValuesRequest, options?: RequestOptions): Promise<operations.ListBreakdownValuesResponse>;
|
|
37
37
|
/**
|
|
@@ -42,7 +42,7 @@ export declare class Metrics extends ClientSDK {
|
|
|
42
42
|
*
|
|
43
43
|
* #### How it works
|
|
44
44
|
*
|
|
45
|
-
* 1. Before using this endpoint, you can call the <a href="https://docs.fastpix.
|
|
45
|
+
* 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.
|
|
46
46
|
*
|
|
47
47
|
* 2. Send a `GET` request to this endpoint with the required `metricId` and other query parameters.
|
|
48
48
|
*
|
|
@@ -57,7 +57,7 @@ export declare class Metrics extends ClientSDK {
|
|
|
57
57
|
* * **totalPlayTime:** Total time spent playing the video, represented in milliseconds.
|
|
58
58
|
* * **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.
|
|
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
|
listOverallValues(request: operations.ListOverallValuesRequest, options?: RequestOptions): Promise<operations.ListOverallValuesResponse>;
|
|
63
63
|
/**
|
|
@@ -90,13 +90,13 @@ export declare class Metrics extends ClientSDK {
|
|
|
90
90
|
*
|
|
91
91
|
* #### How it works
|
|
92
92
|
*
|
|
93
|
-
* 1. Before making a request to this endpoint, call the <a href="https://docs.fastpix.
|
|
93
|
+
* 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.
|
|
94
94
|
*
|
|
95
95
|
* 2. Send a `GET` request to this endpoint with the desired metrics specified in the query parameters.
|
|
96
96
|
*
|
|
97
97
|
* 3. You Receive a response containing the comparison values for the specified metrics across the selected dimensions.
|
|
98
98
|
*
|
|
99
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
99
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/understand-dashboard-ui#compare-metrics">Compare metrics in dashboard</a>
|
|
100
100
|
*/
|
|
101
101
|
listCompares(request?: operations.ListComparisonValuesRequest | undefined, options?: RequestOptions): Promise<operations.ListComparisonValuesResponse>;
|
|
102
102
|
}
|
|
@@ -21,7 +21,7 @@ class Metrics extends sdks_js_1.ClientSDK {
|
|
|
21
21
|
*
|
|
22
22
|
* #### How it works
|
|
23
23
|
*
|
|
24
|
-
* 1. Before using this endpoint, you can call the <a href="https://docs.fastpix.
|
|
24
|
+
* 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.
|
|
25
25
|
*
|
|
26
26
|
* 2. Send a `GET` request to this endpoint with the required `metricId` and other query parameters.
|
|
27
27
|
*
|
|
@@ -43,7 +43,7 @@ class Metrics extends sdks_js_1.ClientSDK {
|
|
|
43
43
|
* * **totalPlayTime:** Total time spent playing the video, represented in milliseconds.
|
|
44
44
|
* * **field:** The grouping field value based on the groupBy parameter.
|
|
45
45
|
*
|
|
46
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
46
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/metrics-overview">Understand data definitions</a>
|
|
47
47
|
*/
|
|
48
48
|
async listBreakdownValues(request, options) {
|
|
49
49
|
return (0, fp_js_1.unwrapAsync)((0, metricsListBreakdownValues_js_1.metricsListBreakdownValues)(this, request, options));
|
|
@@ -56,7 +56,7 @@ class Metrics extends sdks_js_1.ClientSDK {
|
|
|
56
56
|
*
|
|
57
57
|
* #### How it works
|
|
58
58
|
*
|
|
59
|
-
* 1. Before using this endpoint, you can call the <a href="https://docs.fastpix.
|
|
59
|
+
* 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.
|
|
60
60
|
*
|
|
61
61
|
* 2. Send a `GET` request to this endpoint with the required `metricId` and other query parameters.
|
|
62
62
|
*
|
|
@@ -71,7 +71,7 @@ class Metrics extends sdks_js_1.ClientSDK {
|
|
|
71
71
|
* * **totalPlayTime:** Total time spent playing the video, represented in milliseconds.
|
|
72
72
|
* * **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.
|
|
73
73
|
*
|
|
74
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
74
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/metrics-overview">Understand data definitions</a>
|
|
75
75
|
*/
|
|
76
76
|
async listOverallValues(request, options) {
|
|
77
77
|
return (0, fp_js_1.unwrapAsync)((0, metricsListOverallValues_js_1.metricsListOverallValues)(this, request, options));
|
|
@@ -108,13 +108,13 @@ class Metrics extends sdks_js_1.ClientSDK {
|
|
|
108
108
|
*
|
|
109
109
|
* #### How it works
|
|
110
110
|
*
|
|
111
|
-
* 1. Before making a request to this endpoint, call the <a href="https://docs.fastpix.
|
|
111
|
+
* 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.
|
|
112
112
|
*
|
|
113
113
|
* 2. Send a `GET` request to this endpoint with the desired metrics specified in the query parameters.
|
|
114
114
|
*
|
|
115
115
|
* 3. You Receive a response containing the comparison values for the specified metrics across the selected dimensions.
|
|
116
116
|
*
|
|
117
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
117
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/understand-dashboard-ui#compare-metrics">Compare metrics in dashboard</a>
|
|
118
118
|
*/
|
|
119
119
|
async listCompares(request, options) {
|
|
120
120
|
return (0, fp_js_1.unwrapAsync)((0, metricsListCompares_js_1.metricsListCompares)(this, request, options));
|
|
@@ -5,7 +5,7 @@ export declare class Playback extends ClientSDK {
|
|
|
5
5
|
* Create a playback ID
|
|
6
6
|
*
|
|
7
7
|
* @remarks
|
|
8
|
-
* 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.
|
|
8
|
+
* 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.
|
|
9
9
|
*
|
|
10
10
|
* 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.
|
|
11
11
|
*
|
|
@@ -19,7 +19,7 @@ class Playback extends sdks_js_1.ClientSDK {
|
|
|
19
19
|
* Create a playback ID
|
|
20
20
|
*
|
|
21
21
|
* @remarks
|
|
22
|
-
* 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.
|
|
22
|
+
* 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.
|
|
23
23
|
*
|
|
24
24
|
* 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.
|
|
25
25
|
*
|
|
@@ -11,7 +11,7 @@ export declare class Playlist extends ClientSDK {
|
|
|
11
11
|
* - **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.
|
|
12
12
|
* - **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.
|
|
13
13
|
*
|
|
14
|
-
* For more details, see <a href="https://docs.fastpix.
|
|
14
|
+
* For more details, see <a href="https://docs.fastpix.com/docs/create-and-manage-playlist">Create and manage playlist</a>.
|
|
15
15
|
*
|
|
16
16
|
* #### How it works
|
|
17
17
|
*
|
|
@@ -24,7 +24,7 @@ class Playlist extends sdks_js_1.ClientSDK {
|
|
|
24
24
|
* - **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.
|
|
25
25
|
* - **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.
|
|
26
26
|
*
|
|
27
|
-
* For more details, see <a href="https://docs.fastpix.
|
|
27
|
+
* For more details, see <a href="https://docs.fastpix.com/docs/create-and-manage-playlist">Create and manage playlist</a>.
|
|
28
28
|
*
|
|
29
29
|
* #### How it works
|
|
30
30
|
*
|
|
@@ -20,7 +20,7 @@ export declare class SigningKeys extends ClientSDK {
|
|
|
20
20
|
* **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.
|
|
21
21
|
*
|
|
22
22
|
* **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/>
|
|
23
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
23
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/secure-playback-with-jwts">Create and use signing keys</a>
|
|
24
24
|
*/
|
|
25
25
|
create(options?: RequestOptions): Promise<operations.CreateSigningKeyResponse>;
|
|
26
26
|
/**
|
|
@@ -75,7 +75,7 @@ export declare class SigningKeys extends ClientSDK {
|
|
|
75
75
|
* {
|
|
76
76
|
* "kid": "359302ee-2446-4afe-9348-8b4656b9ddb1",
|
|
77
77
|
* "aud": "media:6cee6f85-9334-4a51-9ce3-e0241d94ceef",
|
|
78
|
-
* "iss": "fastpix.
|
|
78
|
+
* "iss": "fastpix.com",
|
|
79
79
|
* "sub": "",
|
|
80
80
|
* "iat": 1706703204,
|
|
81
81
|
* "exp": 1735626783
|
|
@@ -85,7 +85,7 @@ export declare class SigningKeys extends ClientSDK {
|
|
|
85
85
|
*
|
|
86
86
|
* * **kid:** The key ID of the signing key.
|
|
87
87
|
* * **aud:** The audience for which the token is intended, enter the playbackId here.
|
|
88
|
-
* * **iss:** The issuer of the token (for example, "fastpix.
|
|
88
|
+
* * **iss:** The issuer of the token (for example, "fastpix.com ").
|
|
89
89
|
* * **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.
|
|
90
90
|
* * **groups:** An array of groups the subject belongs to (for example, ["user"]).
|
|
91
91
|
* * **iat:** The issued-at timestamp, indicating when the token was created.
|
|
@@ -32,7 +32,7 @@ class SigningKeys extends sdks_js_1.ClientSDK {
|
|
|
32
32
|
* **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.
|
|
33
33
|
*
|
|
34
34
|
* **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/>
|
|
35
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
35
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/secure-playback-with-jwts">Create and use signing keys</a>
|
|
36
36
|
*/
|
|
37
37
|
async create(options) {
|
|
38
38
|
return (0, fp_js_1.unwrapAsync)((0, signingKeysCreate_js_1.signingKeysCreate)(this, options));
|
|
@@ -93,7 +93,7 @@ class SigningKeys extends sdks_js_1.ClientSDK {
|
|
|
93
93
|
* {
|
|
94
94
|
* "kid": "359302ee-2446-4afe-9348-8b4656b9ddb1",
|
|
95
95
|
* "aud": "media:6cee6f85-9334-4a51-9ce3-e0241d94ceef",
|
|
96
|
-
* "iss": "fastpix.
|
|
96
|
+
* "iss": "fastpix.com",
|
|
97
97
|
* "sub": "",
|
|
98
98
|
* "iat": 1706703204,
|
|
99
99
|
* "exp": 1735626783
|
|
@@ -103,7 +103,7 @@ class SigningKeys extends sdks_js_1.ClientSDK {
|
|
|
103
103
|
*
|
|
104
104
|
* * **kid:** The key ID of the signing key.
|
|
105
105
|
* * **aud:** The audience for which the token is intended, enter the playbackId here.
|
|
106
|
-
* * **iss:** The issuer of the token (for example, "fastpix.
|
|
106
|
+
* * **iss:** The issuer of the token (for example, "fastpix.com ").
|
|
107
107
|
* * **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.
|
|
108
108
|
* * **groups:** An array of groups the subject belongs to (for example, ["user"]).
|
|
109
109
|
* * **iat:** The issued-at timestamp, indicating when the token was created.
|
|
@@ -10,12 +10,12 @@ export declare class Simulcasts extends ClientSDK {
|
|
|
10
10
|
*
|
|
11
11
|
* 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.
|
|
12
12
|
*
|
|
13
|
-
* 2. To notify your application about the status of simulcast related events check for the <a href="https://docs.fastpix.
|
|
13
|
+
* 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.
|
|
14
14
|
*
|
|
15
15
|
* #### Example
|
|
16
16
|
* 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.
|
|
17
17
|
*
|
|
18
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
18
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/simulcast-to-3rd-party-platforms">Simulcast to 3rd party platforms</a>
|
|
19
19
|
*/
|
|
20
20
|
create(request: operations.CreateSimulcastOfStreamRequest, options?: RequestOptions): Promise<operations.CreateSimulcastOfStreamResponse>;
|
|
21
21
|
/**
|
|
@@ -34,7 +34,7 @@ export declare class Simulcasts extends ClientSDK {
|
|
|
34
34
|
* @remarks
|
|
35
35
|
* 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.
|
|
36
36
|
*
|
|
37
|
-
* Webhook event: <a href="https://docs.fastpix.
|
|
37
|
+
* Webhook event: <a href="https://docs.fastpix.com/docs/live-events#videolive_streamsimulcast_targetupdated">video.live_stream.simulcast_target.updated</a>
|
|
38
38
|
*
|
|
39
39
|
* #### Example
|
|
40
40
|
* 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.
|
|
@@ -21,12 +21,12 @@ class Simulcasts extends sdks_js_1.ClientSDK {
|
|
|
21
21
|
*
|
|
22
22
|
* 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.
|
|
23
23
|
*
|
|
24
|
-
* 2. To notify your application about the status of simulcast related events check for the <a href="https://docs.fastpix.
|
|
24
|
+
* 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.
|
|
25
25
|
*
|
|
26
26
|
* #### Example
|
|
27
27
|
* 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.
|
|
28
28
|
*
|
|
29
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
29
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/simulcast-to-3rd-party-platforms">Simulcast to 3rd party platforms</a>
|
|
30
30
|
*/
|
|
31
31
|
async create(request, options) {
|
|
32
32
|
return (0, fp_js_1.unwrapAsync)((0, simulcastsCreate_js_1.simulcastsCreate)(this, request, options));
|
|
@@ -49,7 +49,7 @@ class Simulcasts extends sdks_js_1.ClientSDK {
|
|
|
49
49
|
* @remarks
|
|
50
50
|
* 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.
|
|
51
51
|
*
|
|
52
|
-
* Webhook event: <a href="https://docs.fastpix.
|
|
52
|
+
* Webhook event: <a href="https://docs.fastpix.com/docs/live-events#videolive_streamsimulcast_targetupdated">video.live_stream.simulcast_target.updated</a>
|
|
53
53
|
*
|
|
54
54
|
* #### Example
|
|
55
55
|
* 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.
|
|
@@ -7,7 +7,7 @@ export declare class SimulcastStreams extends ClientSDK {
|
|
|
7
7
|
* @remarks
|
|
8
8
|
* 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.
|
|
9
9
|
*
|
|
10
|
-
* Webhook event: <a href="https://docs.fastpix.
|
|
10
|
+
* Webhook event: <a href="https://docs.fastpix.com/docs/live-events#videolive_streamsimulcast_targetdeleted">video.live_stream.simulcast_target.deleted</a>
|
|
11
11
|
*
|
|
12
12
|
* #### Example
|
|
13
13
|
* 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.
|
|
@@ -16,7 +16,7 @@ class SimulcastStreams extends sdks_js_1.ClientSDK {
|
|
|
16
16
|
* @remarks
|
|
17
17
|
* 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.
|
|
18
18
|
*
|
|
19
|
-
* Webhook event: <a href="https://docs.fastpix.
|
|
19
|
+
* Webhook event: <a href="https://docs.fastpix.com/docs/live-events#videolive_streamsimulcast_targetdeleted">video.live_stream.simulcast_target.deleted</a>
|
|
20
20
|
*
|
|
21
21
|
* #### Example
|
|
22
22
|
* 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.
|
|
@@ -13,7 +13,7 @@ export declare class Views extends ClientSDK {
|
|
|
13
13
|
*
|
|
14
14
|
* 2. Specify the timespan for which you want to retrieve the video views using the `timespan[]` parameter.
|
|
15
15
|
*
|
|
16
|
-
* 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.
|
|
16
|
+
* 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.
|
|
17
17
|
*
|
|
18
18
|
* 4. Paginate the results using the `limit` and `offset` parameters.
|
|
19
19
|
*
|
|
@@ -21,13 +21,13 @@ export declare class Views extends ClientSDK {
|
|
|
21
21
|
*
|
|
22
22
|
* 6. You receive a response containing the list of video views matching the specified criteria.
|
|
23
23
|
*
|
|
24
|
-
* Each view in the response includes a unique `viewId`. You can use this `viewId` with the <a href="https://docs.fastpix.
|
|
24
|
+
* 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.
|
|
25
25
|
*
|
|
26
26
|
* #### Example
|
|
27
27
|
*
|
|
28
28
|
* 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.
|
|
29
29
|
*
|
|
30
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
30
|
+
* 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>
|
|
31
31
|
*/
|
|
32
32
|
list(request?: operations.ListVideoViewsRequest | undefined, options?: RequestOptions): Promise<operations.ListVideoViewsResponse>;
|
|
33
33
|
/**
|
|
@@ -42,7 +42,7 @@ export declare class Views extends ClientSDK {
|
|
|
42
42
|
*
|
|
43
43
|
* 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.
|
|
44
44
|
*
|
|
45
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
45
|
+
* Related guide: <a href="https://docs.fastpix.com/page/what-video-data-do-we-capture#/">What Video Data do we capture?</a>
|
|
46
46
|
*/
|
|
47
47
|
getDetails(request: operations.GetVideoViewDetailsRequest, options?: RequestOptions): Promise<operations.GetVideoViewDetailsResponse>;
|
|
48
48
|
/**
|
|
@@ -63,7 +63,7 @@ export declare class Views extends ClientSDK {
|
|
|
63
63
|
*
|
|
64
64
|
* 5. You receive a response containing the list of top video views matching the specified criteria.
|
|
65
65
|
*
|
|
66
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
66
|
+
* Related guide: <a href="https://docs.fastpix.com/page/how-to-get-top-performing-content">Get top-performing content</a>
|
|
67
67
|
*/
|
|
68
68
|
listTopContent(request?: operations.ListByTopContentRequest | undefined, options?: RequestOptions): Promise<operations.ListByTopContentResponse>;
|
|
69
69
|
}
|
|
@@ -24,7 +24,7 @@ class Views extends sdks_js_1.ClientSDK {
|
|
|
24
24
|
*
|
|
25
25
|
* 2. Specify the timespan for which you want to retrieve the video views using the `timespan[]` parameter.
|
|
26
26
|
*
|
|
27
|
-
* 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.
|
|
27
|
+
* 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.
|
|
28
28
|
*
|
|
29
29
|
* 4. Paginate the results using the `limit` and `offset` parameters.
|
|
30
30
|
*
|
|
@@ -32,13 +32,13 @@ class Views extends sdks_js_1.ClientSDK {
|
|
|
32
32
|
*
|
|
33
33
|
* 6. You receive a response containing the list of video views matching the specified criteria.
|
|
34
34
|
*
|
|
35
|
-
* Each view in the response includes a unique `viewId`. You can use this `viewId` with the <a href="https://docs.fastpix.
|
|
35
|
+
* 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.
|
|
36
36
|
*
|
|
37
37
|
* #### Example
|
|
38
38
|
*
|
|
39
39
|
* 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.
|
|
40
40
|
*
|
|
41
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
41
|
+
* 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>
|
|
42
42
|
*/
|
|
43
43
|
async list(request, options) {
|
|
44
44
|
return (0, fp_js_1.unwrapAsync)((0, viewsList_js_1.viewsList)(this, request, options));
|
|
@@ -55,7 +55,7 @@ class Views extends sdks_js_1.ClientSDK {
|
|
|
55
55
|
*
|
|
56
56
|
* 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.
|
|
57
57
|
*
|
|
58
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
58
|
+
* Related guide: <a href="https://docs.fastpix.com/page/what-video-data-do-we-capture#/">What Video Data do we capture?</a>
|
|
59
59
|
*/
|
|
60
60
|
async getDetails(request, options) {
|
|
61
61
|
return (0, fp_js_1.unwrapAsync)((0, viewsGetDetails_js_1.viewsGetDetails)(this, request, options));
|
|
@@ -78,7 +78,7 @@ class Views extends sdks_js_1.ClientSDK {
|
|
|
78
78
|
*
|
|
79
79
|
* 5. You receive a response containing the list of top video views matching the specified criteria.
|
|
80
80
|
*
|
|
81
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
81
|
+
* Related guide: <a href="https://docs.fastpix.com/page/how-to-get-top-performing-content">Get top-performing content</a>
|
|
82
82
|
*/
|
|
83
83
|
async listTopContent(request, options) {
|
|
84
84
|
return (0, fp_js_1.unwrapAsync)((0, viewsListTopContent_js_1.viewsListTopContent)(this, request, options));
|
|
@@ -23,11 +23,11 @@ import { Result } from "../types/fp.js";
|
|
|
23
23
|
* 2. Include the `namedEntities` parameter in the request body to enable.
|
|
24
24
|
* 3. Receive a response containing the updated media data, confirming the changes made.
|
|
25
25
|
*
|
|
26
|
-
* You can use the <a href="https://docs.fastpix.
|
|
26
|
+
* You can use the <a href="https://docs.fastpix.com/docs/ai-events#videomediaainamedentitiesready">video.mediaAI.named-entities.ready</a> webhook event to track and notify about the named entities extraction.
|
|
27
27
|
*
|
|
28
28
|
* **Use case:** If a user uploads a video and later decides to enable named entity extraction without re-uploading the entire video.
|
|
29
29
|
*
|
|
30
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
30
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/generate-named-entities">Named entities</a>
|
|
31
31
|
*/
|
|
32
32
|
export declare function aiFeaturesGenerateNamedEntities(client: FastpixCore, request: operations.UpdateMediaNamedEntitiesRequest, options?: RequestOptions): APIPromise<Result<operations.UpdateMediaNamedEntitiesResponse, FastpixError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
33
33
|
//# sourceMappingURL=aiFeaturesGenerateNamedEntities.d.ts.map
|
|
@@ -28,11 +28,11 @@ import { APIPromise } from "../types/async.js";
|
|
|
28
28
|
* 2. Include the `namedEntities` parameter in the request body to enable.
|
|
29
29
|
* 3. Receive a response containing the updated media data, confirming the changes made.
|
|
30
30
|
*
|
|
31
|
-
* You can use the <a href="https://docs.fastpix.
|
|
31
|
+
* You can use the <a href="https://docs.fastpix.com/docs/ai-events#videomediaainamedentitiesready">video.mediaAI.named-entities.ready</a> webhook event to track and notify about the named entities extraction.
|
|
32
32
|
*
|
|
33
33
|
* **Use case:** If a user uploads a video and later decides to enable named entity extraction without re-uploading the entire video.
|
|
34
34
|
*
|
|
35
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
35
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/generate-named-entities">Named entities</a>
|
|
36
36
|
*/
|
|
37
37
|
export function aiFeaturesGenerateNamedEntities(client, request, options) {
|
|
38
38
|
return new APIPromise($do(client, request, options));
|
|
@@ -19,11 +19,11 @@ import { Result } from "../types/fp.js";
|
|
|
19
19
|
* 3. Include the `summaryLength` parameter, specify the desired length of the summary in words (for example, 120 words), this determines how concise or detailed the summary will be. If no specific summary length is provided, the default length will be 100 words.
|
|
20
20
|
* 4. The response includes the updated media data and confirmation of the changes applied.
|
|
21
21
|
*
|
|
22
|
-
* You can use the <a href="https://docs.fastpix.
|
|
22
|
+
* You can use the <a href="https://docs.fastpix.com/docs/ai-events#videomediaaisummaryready">video.mediaAI.summary.ready</a> webhook event to track and notify about the summary generation.
|
|
23
23
|
*
|
|
24
24
|
* **Use case**: This is particularly useful when a user uploads a video and later chooses to generate a summary without needing to re-upload the video.
|
|
25
25
|
*
|
|
26
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
26
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/generate-video-summary">Video summary</a>
|
|
27
27
|
*/
|
|
28
28
|
export declare function aiFeaturesUpdateSummary(client: FastpixCore, request: operations.UpdateMediaSummaryRequest, options?: RequestOptions): APIPromise<Result<operations.UpdateMediaSummaryResponse, FastpixError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
29
29
|
//# sourceMappingURL=aiFeaturesUpdateSummary.d.ts.map
|
|
@@ -24,11 +24,11 @@ import { APIPromise } from "../types/async.js";
|
|
|
24
24
|
* 3. Include the `summaryLength` parameter, specify the desired length of the summary in words (for example, 120 words), this determines how concise or detailed the summary will be. If no specific summary length is provided, the default length will be 100 words.
|
|
25
25
|
* 4. The response includes the updated media data and confirmation of the changes applied.
|
|
26
26
|
*
|
|
27
|
-
* You can use the <a href="https://docs.fastpix.
|
|
27
|
+
* You can use the <a href="https://docs.fastpix.com/docs/ai-events#videomediaaisummaryready">video.mediaAI.summary.ready</a> webhook event to track and notify about the summary generation.
|
|
28
28
|
*
|
|
29
29
|
* **Use case**: This is particularly useful when a user uploads a video and later chooses to generate a summary without needing to re-upload the video.
|
|
30
30
|
*
|
|
31
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
31
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/generate-video-summary">Video summary</a>
|
|
32
32
|
*/
|
|
33
33
|
export function aiFeaturesUpdateSummary(client, request, options) {
|
|
34
34
|
return new APIPromise($do(client, request, options));
|
|
@@ -13,9 +13,9 @@ import { Result } from "../types/fp.js";
|
|
|
13
13
|
* @remarks
|
|
14
14
|
* Retrieves a list of dimensions that can be used as query parameters across various data endpoints. Each dimension has a unique id that can be used to filter data effectively.
|
|
15
15
|
*
|
|
16
|
-
* The dimensions retrieved from this endpoint can be used in conjunction with the <a href="https://docs.fastpix.
|
|
16
|
+
* The dimensions retrieved from this endpoint can be used in conjunction with the <a href="https://docs.fastpix.com/reference/list_video_views">list video views</a> and <a href="https://docs.fastpix.com/reference/list_by_top_content">list by top content</a> endpoints to filter results based on specific criteria. For example, you can filter views by `browser_name`, `os_name`, `device_type`, and more.
|
|
17
17
|
*
|
|
18
|
-
* Related guides: <a href="https://docs.fastpix.
|
|
18
|
+
* Related guides: <a href="https://docs.fastpix.com/page/what-video-data-do-we-capture#/">What Video Data do we capture?</a> , <a href="https://docs.fastpix.com/docs/user-passable-metadata-1">Use passable dimensions</a>
|
|
19
19
|
*/
|
|
20
20
|
export declare function dimensionsList(client: FastpixCore, options?: RequestOptions): APIPromise<Result<operations.ListDimensionsResponse, FastpixError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
21
21
|
//# sourceMappingURL=dimensionsList.d.ts.map
|
|
@@ -15,9 +15,9 @@ import { APIPromise } from "../types/async.js";
|
|
|
15
15
|
* @remarks
|
|
16
16
|
* Retrieves a list of dimensions that can be used as query parameters across various data endpoints. Each dimension has a unique id that can be used to filter data effectively.
|
|
17
17
|
*
|
|
18
|
-
* The dimensions retrieved from this endpoint can be used in conjunction with the <a href="https://docs.fastpix.
|
|
18
|
+
* The dimensions retrieved from this endpoint can be used in conjunction with the <a href="https://docs.fastpix.com/reference/list_video_views">list video views</a> and <a href="https://docs.fastpix.com/reference/list_by_top_content">list by top content</a> endpoints to filter results based on specific criteria. For example, you can filter views by `browser_name`, `os_name`, `device_type`, and more.
|
|
19
19
|
*
|
|
20
|
-
* Related guides: <a href="https://docs.fastpix.
|
|
20
|
+
* Related guides: <a href="https://docs.fastpix.com/page/what-video-data-do-we-capture#/">What Video Data do we capture?</a> , <a href="https://docs.fastpix.com/docs/user-passable-metadata-1">Use passable dimensions</a>
|
|
21
21
|
*/
|
|
22
22
|
export function dimensionsList(client, options) {
|
|
23
23
|
return new APIPromise($do(client, options));
|
|
@@ -13,13 +13,13 @@ import { Result } from "../types/fp.js";
|
|
|
13
13
|
* @remarks
|
|
14
14
|
* This endpoint returns the filter values associated with a specific dimension, along with the total number of video views for each value. For example, it can list all `browser_name` (dimension) and show how many views occurred for all available browsers like Chrome, Safari (filter values).
|
|
15
15
|
*
|
|
16
|
-
* In order to use the <a href="https://docs.fastpix.
|
|
16
|
+
* In order to use the <a href="https://docs.fastpix.com/docs/custom-business-metadata">Custom Dimensions</a>, you must enable them in the dashboard under settings option based on the plan you have opted for.
|
|
17
17
|
*
|
|
18
18
|
* #### Example
|
|
19
19
|
*
|
|
20
20
|
* A developer wants to know how their video content performs across different browsers. By calling this endpoint for the `device_type` dimension, they can retrieve a breakdown of video views by each device (for example, Desktop, Mobile, Tablet). This data helps the developer understand where optimizations or troubleshooting is necessary.
|
|
21
21
|
*
|
|
22
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
22
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/understand-dashboard-ui#filters-and-timeframes">Filters and timespan</a>
|
|
23
23
|
*/
|
|
24
24
|
export declare function dimensionsListFilterValues(client: FastpixCore, request: operations.ListFilterValuesForDimensionRequest, options?: RequestOptions): APIPromise<Result<operations.ListFilterValuesForDimensionResponse, FastpixError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
25
25
|
//# sourceMappingURL=dimensionsListFilterValues.d.ts.map
|
|
@@ -18,13 +18,13 @@ import { APIPromise } from "../types/async.js";
|
|
|
18
18
|
* @remarks
|
|
19
19
|
* This endpoint returns the filter values associated with a specific dimension, along with the total number of video views for each value. For example, it can list all `browser_name` (dimension) and show how many views occurred for all available browsers like Chrome, Safari (filter values).
|
|
20
20
|
*
|
|
21
|
-
* In order to use the <a href="https://docs.fastpix.
|
|
21
|
+
* In order to use the <a href="https://docs.fastpix.com/docs/custom-business-metadata">Custom Dimensions</a>, you must enable them in the dashboard under settings option based on the plan you have opted for.
|
|
22
22
|
*
|
|
23
23
|
* #### Example
|
|
24
24
|
*
|
|
25
25
|
* A developer wants to know how their video content performs across different browsers. By calling this endpoint for the `device_type` dimension, they can retrieve a breakdown of video views by each device (for example, Desktop, Mobile, Tablet). This data helps the developer understand where optimizations or troubleshooting is necessary.
|
|
26
26
|
*
|
|
27
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
27
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/understand-dashboard-ui#filters-and-timeframes">Filters and timespan</a>
|
|
28
28
|
*/
|
|
29
29
|
export function dimensionsListFilterValues(client, request, options) {
|
|
30
30
|
return new APIPromise($do(client, request, options));
|
|
@@ -18,7 +18,7 @@ import { Result } from "../types/fp.js";
|
|
|
18
18
|
* 1. Make a GET request to this endpoint, replacing `{drmConfigurationId}` with the UUID of the DRM configuration.
|
|
19
19
|
* 2. The response contains the associated DRM configuration ID.
|
|
20
20
|
*
|
|
21
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
21
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/secure-playback-with-drm">Manage DRM configuration</a>
|
|
22
22
|
*/
|
|
23
23
|
export declare function drmConfigurationsGet(client: FastpixCore, request: operations.GetDrmConfigurationByIdRequest, options?: RequestOptions): APIPromise<Result<operations.GetDrmConfigurationByIdResponse, FastpixError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
24
24
|
//# sourceMappingURL=drmConfigurationsGet.d.ts.map
|