@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
package/FUNCTIONS.md
CHANGED
package/README.md
CHANGED
|
@@ -23,7 +23,7 @@ The FastPix Node.js SDK simplifies integration with the FastPix platform. It pro
|
|
|
23
23
|
To get started with the FastPix Node.js SDK, ensure you have the following:
|
|
24
24
|
|
|
25
25
|
- The FastPix APIs are authenticated using a **Username** and a **Password**. You must generate these credentials to use the SDK.
|
|
26
|
-
- Follow the steps in the [Authentication with Basic Auth](https://
|
|
26
|
+
- Follow the steps in the [Authentication with Basic Auth](https://fastpix.com/docs/getting-started/activate-your-account#authentication-format) guide to obtain your credentials.
|
|
27
27
|
|
|
28
28
|
### Environment Variables (Optional)
|
|
29
29
|
|
|
@@ -141,7 +141,7 @@ async function run() {
|
|
|
141
141
|
inputs: [
|
|
142
142
|
{
|
|
143
143
|
type: "video",
|
|
144
|
-
url: "https://static.fastpix.
|
|
144
|
+
url: "https://static.fastpix.com/fp-sample-video.mp4",
|
|
145
145
|
},
|
|
146
146
|
],
|
|
147
147
|
metadata: {
|
|
@@ -163,7 +163,7 @@ Comprehensive Node.js SDK for FastPix platform integration with full API coverag
|
|
|
163
163
|
|
|
164
164
|
Upload, manage, and transform video content with comprehensive media management capabilities.
|
|
165
165
|
|
|
166
|
-
For detailed documentation, see [FastPix Video on Demand Overview](https://
|
|
166
|
+
For detailed documentation, see [FastPix Video on Demand Overview](https://fastpix.com/docs/get-started/overview).
|
|
167
167
|
|
|
168
168
|
#### Input Video
|
|
169
169
|
- [Create from URL](docs/sdks/inputvideo/README.md#create) - Upload video content from external URL
|
|
@@ -207,7 +207,7 @@ For detailed documentation, see [FastPix Video on Demand Overview](https://docs.
|
|
|
207
207
|
|
|
208
208
|
Stream, manage, and transform live video content with real-time broadcasting capabilities.
|
|
209
209
|
|
|
210
|
-
For detailed documentation, see [FastPix Live Stream Overview](https://
|
|
210
|
+
For detailed documentation, see [FastPix Live Stream Overview](https://fastpix.com/docs/get-started/live-overview).
|
|
211
211
|
|
|
212
212
|
#### Start Live Stream
|
|
213
213
|
- [Create Stream](docs/sdks/livestreams/README.md#create) - Initialize new live streaming session with DVR mode support
|
|
@@ -237,7 +237,7 @@ For detailed documentation, see [FastPix Live Stream Overview](https://docs.fast
|
|
|
237
237
|
|
|
238
238
|
Monitor video performance and quality with comprehensive analytics and real-time metrics.
|
|
239
239
|
|
|
240
|
-
For detailed documentation, see [FastPix Video Data Overview](https://
|
|
240
|
+
For detailed documentation, see [FastPix Video Data Overview](https://fastpix.com/docs/concepts/what-video-data-do-we-capture).
|
|
241
241
|
|
|
242
242
|
#### Metrics
|
|
243
243
|
- [List Breakdown Values](docs/sdks/metrics/README.md#listbreakdownvalues) - Get detailed breakdown of metrics by dimension
|
|
@@ -404,7 +404,7 @@ async function run() {
|
|
|
404
404
|
inputs: [
|
|
405
405
|
{
|
|
406
406
|
type: "video",
|
|
407
|
-
url: "https://static.fastpix.
|
|
407
|
+
url: "https://static.fastpix.com/fp-sample-video.mp4",
|
|
408
408
|
},
|
|
409
409
|
],
|
|
410
410
|
metadata: {
|
|
@@ -456,7 +456,7 @@ async function run() {
|
|
|
456
456
|
inputs: [
|
|
457
457
|
{
|
|
458
458
|
type: "video",
|
|
459
|
-
url: "https://static.fastpix.
|
|
459
|
+
url: "https://static.fastpix.com/fp-sample-video.mp4",
|
|
460
460
|
},
|
|
461
461
|
],
|
|
462
462
|
metadata: {
|
|
@@ -503,7 +503,7 @@ async function run() {
|
|
|
503
503
|
inputs: [
|
|
504
504
|
{
|
|
505
505
|
type: "video",
|
|
506
|
-
url: "https://static.fastpix.
|
|
506
|
+
url: "https://static.fastpix.com/fp-sample-video.mp4",
|
|
507
507
|
},
|
|
508
508
|
],
|
|
509
509
|
metadata: {
|
|
@@ -558,7 +558,7 @@ The default server can be overridden globally by passing a URL to the `serverURL
|
|
|
558
558
|
import { Fastpix } from "@fastpix/fastpix-node";
|
|
559
559
|
|
|
560
560
|
const fastpix = new Fastpix({
|
|
561
|
-
serverURL: "https://api.fastpix.
|
|
561
|
+
serverURL: "https://api.fastpix.com/v1/",
|
|
562
562
|
security: {
|
|
563
563
|
username: "your-access-token",
|
|
564
564
|
password: "your-secret-key",
|
|
@@ -570,7 +570,7 @@ async function run() {
|
|
|
570
570
|
inputs: [
|
|
571
571
|
{
|
|
572
572
|
type: "video",
|
|
573
|
-
url: "https://static.fastpix.
|
|
573
|
+
url: "https://static.fastpix.com/fp-sample-video.mp4",
|
|
574
574
|
},
|
|
575
575
|
],
|
|
576
576
|
metadata: {
|
|
@@ -664,6 +664,6 @@ We value community contributions and feedback. Feel free to submit pull requests
|
|
|
664
664
|
|
|
665
665
|
## Detailed Usage
|
|
666
666
|
|
|
667
|
-
For comprehensive understanding of each API's functionality, including detailed request and response specifications, parameter descriptions, and additional examples, please refer to the [FastPix API Reference](https://
|
|
667
|
+
For comprehensive understanding of each API's functionality, including detailed request and response specifications, parameter descriptions, and additional examples, please refer to the [FastPix API Reference](https://fastpix.com/docs/video-security/secure-media-access-with-jwts).
|
|
668
668
|
|
|
669
669
|
The API reference offers complete documentation for all available endpoints and features, enabling developers to integrate and leverage FastPix APIs effectively.
|
|
@@ -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
|
|
@@ -64,11 +64,11 @@ const async_js_1 = require("../types/async.js");
|
|
|
64
64
|
* 2. Include the `namedEntities` parameter in the request body to enable.
|
|
65
65
|
* 3. Receive a response containing the updated media data, confirming the changes made.
|
|
66
66
|
*
|
|
67
|
-
* You can use the <a href="https://docs.fastpix.
|
|
67
|
+
* 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.
|
|
68
68
|
*
|
|
69
69
|
* **Use case:** If a user uploads a video and later decides to enable named entity extraction without re-uploading the entire video.
|
|
70
70
|
*
|
|
71
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
71
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/generate-named-entities">Named entities</a>
|
|
72
72
|
*/
|
|
73
73
|
function aiFeaturesGenerateNamedEntities(client, request, options) {
|
|
74
74
|
return new async_js_1.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
|
|
@@ -60,11 +60,11 @@ const async_js_1 = require("../types/async.js");
|
|
|
60
60
|
* 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.
|
|
61
61
|
* 4. The response includes the updated media data and confirmation of the changes applied.
|
|
62
62
|
*
|
|
63
|
-
* You can use the <a href="https://docs.fastpix.
|
|
63
|
+
* 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.
|
|
64
64
|
*
|
|
65
65
|
* **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.
|
|
66
66
|
*
|
|
67
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
67
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/generate-video-summary">Video summary</a>
|
|
68
68
|
*/
|
|
69
69
|
function aiFeaturesUpdateSummary(client, request, options) {
|
|
70
70
|
return new async_js_1.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
|
|
@@ -51,9 +51,9 @@ const async_js_1 = require("../types/async.js");
|
|
|
51
51
|
* @remarks
|
|
52
52
|
* 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.
|
|
53
53
|
*
|
|
54
|
-
* The dimensions retrieved from this endpoint can be used in conjunction with the <a href="https://docs.fastpix.
|
|
54
|
+
* 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.
|
|
55
55
|
*
|
|
56
|
-
* Related guides: <a href="https://docs.fastpix.
|
|
56
|
+
* 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>
|
|
57
57
|
*/
|
|
58
58
|
function dimensionsList(client, options) {
|
|
59
59
|
return new async_js_1.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
|
|
@@ -54,13 +54,13 @@ const async_js_1 = require("../types/async.js");
|
|
|
54
54
|
* @remarks
|
|
55
55
|
* 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).
|
|
56
56
|
*
|
|
57
|
-
* In order to use the <a href="https://docs.fastpix.
|
|
57
|
+
* 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.
|
|
58
58
|
*
|
|
59
59
|
* #### Example
|
|
60
60
|
*
|
|
61
61
|
* 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.
|
|
62
62
|
*
|
|
63
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
63
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/understand-dashboard-ui#filters-and-timeframes">Filters and timespan</a>
|
|
64
64
|
*/
|
|
65
65
|
function dimensionsListFilterValues(client, request, options) {
|
|
66
66
|
return new async_js_1.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
|
|
@@ -59,7 +59,7 @@ const async_js_1 = require("../types/async.js");
|
|
|
59
59
|
* 1. Make a GET request to this endpoint, replacing `{drmConfigurationId}` with the UUID of the DRM configuration.
|
|
60
60
|
* 2. The response contains the associated DRM configuration ID.
|
|
61
61
|
*
|
|
62
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
62
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/secure-playback-with-drm">Manage DRM configuration</a>
|
|
63
63
|
*/
|
|
64
64
|
function drmConfigurationsGet(client, request, options) {
|
|
65
65
|
return new async_js_1.APIPromise($do(client, request, options));
|
|
@@ -22,7 +22,7 @@ import { Result } from "../types/fp.js";
|
|
|
22
22
|
* **Example:**
|
|
23
23
|
* A media service provider may retrieve DRM configuration for a workspace to create DRM content.
|
|
24
24
|
*
|
|
25
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
25
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/secure-playback-with-drm">Manage DRM configuration</a>
|
|
26
26
|
*/
|
|
27
27
|
export declare function drmConfigurationsList(client: FastpixCore, request?: operations.GetDrmConfigurationRequest | undefined, options?: RequestOptions): APIPromise<Result<operations.GetDrmConfigurationResponse, FastpixError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
28
28
|
//# sourceMappingURL=drmConfigurationsList.d.ts.map
|
|
@@ -63,7 +63,7 @@ const async_js_1 = require("../types/async.js");
|
|
|
63
63
|
* **Example:**
|
|
64
64
|
* A media service provider may retrieve DRM configuration for a workspace to create DRM content.
|
|
65
65
|
*
|
|
66
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
66
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/secure-playback-with-drm">Manage DRM configuration</a>
|
|
67
67
|
*/
|
|
68
68
|
function drmConfigurationsList(client, request, options) {
|
|
69
69
|
return new async_js_1.APIPromise($do(client, request, options));
|
|
@@ -25,7 +25,7 @@ import { Result } from "../types/fp.js";
|
|
|
25
25
|
* * **count:** The number of occurrences of the specific error.
|
|
26
26
|
* * **code:** The error code associated with the specific error.
|
|
27
27
|
*
|
|
28
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
28
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/track-playback-errors">Troubleshoot errors</a>
|
|
29
29
|
*/
|
|
30
30
|
export declare function errorsList(client: FastpixCore, request?: operations.ListErrorsRequest | undefined, options?: RequestOptions): APIPromise<Result<operations.ListErrorsResponse, FastpixError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
31
31
|
//# sourceMappingURL=errorsList.d.ts.map
|
|
@@ -66,7 +66,7 @@ const async_js_1 = require("../types/async.js");
|
|
|
66
66
|
* * **count:** The number of occurrences of the specific error.
|
|
67
67
|
* * **code:** The error code associated with the specific error.
|
|
68
68
|
*
|
|
69
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
69
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/track-playback-errors">Troubleshoot errors</a>
|
|
70
70
|
*/
|
|
71
71
|
function errorsList(client, request, options) {
|
|
72
72
|
return new async_js_1.APIPromise($do(client, request, options));
|
|
@@ -18,11 +18,11 @@ import { Result } from "../types/fp.js";
|
|
|
18
18
|
* 2. Include the `moderation` object and provide the requried `type` parameter in the request body to specify the media type (for example, video/audio/av).
|
|
19
19
|
* 4. The response contains the updated media data, confirming the changes made.
|
|
20
20
|
*
|
|
21
|
-
* You can use the <a href="https://docs.fastpix.
|
|
21
|
+
* You can use the <a href="https://docs.fastpix.com/docs/ai-events#videomediaaimoderationready">video.mediaAI.moderation.ready</a> webhook event to track and notify about the detected moderation results.
|
|
22
22
|
*
|
|
23
23
|
* **Use case:** This is particularly useful when a user uploads a video and later decides to enable moderation detection without the need to re-upload it.
|
|
24
24
|
*
|
|
25
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
25
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/using-nsfw-and-profanity-filter-for-video-moderation">Moderate NSFW & Profanity</a>
|
|
26
26
|
*/
|
|
27
27
|
export declare function inVideoAIUpdateModeration(client: FastpixCore, request: operations.UpdateMediaModerationRequest, options?: RequestOptions): APIPromise<Result<operations.UpdateMediaModerationResponse, FastpixError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
28
28
|
//# sourceMappingURL=inVideoAIUpdateModeration.d.ts.map
|
|
@@ -59,11 +59,11 @@ const async_js_1 = require("../types/async.js");
|
|
|
59
59
|
* 2. Include the `moderation` object and provide the requried `type` parameter in the request body to specify the media type (for example, video/audio/av).
|
|
60
60
|
* 4. The response contains the updated media data, confirming the changes made.
|
|
61
61
|
*
|
|
62
|
-
* You can use the <a href="https://docs.fastpix.
|
|
62
|
+
* You can use the <a href="https://docs.fastpix.com/docs/ai-events#videomediaaimoderationready">video.mediaAI.moderation.ready</a> webhook event to track and notify about the detected moderation results.
|
|
63
63
|
*
|
|
64
64
|
* **Use case:** This is particularly useful when a user uploads a video and later decides to enable moderation detection without the need to re-upload it.
|
|
65
65
|
*
|
|
66
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
66
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/using-nsfw-and-profanity-filter-for-video-moderation">Moderate NSFW & Profanity</a>
|
|
67
67
|
*/
|
|
68
68
|
function inVideoAIUpdateModeration(client, request, options) {
|
|
69
69
|
return new async_js_1.APIPromise($do(client, request, options));
|
|
@@ -18,11 +18,11 @@ import { Result } from "../types/fp.js";
|
|
|
18
18
|
* 2. Include the `chapters` parameter in the request body to enable.
|
|
19
19
|
* 3. The response contains the updated media data, confirming the changes made.
|
|
20
20
|
*
|
|
21
|
-
* You can use the <a href="https://docs.fastpix.
|
|
21
|
+
* 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.
|
|
22
22
|
*
|
|
23
23
|
* **Use case:** This is particularly useful when a user uploads a video and later decides to enable chapters without re-uploading the entire video.
|
|
24
24
|
*
|
|
25
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
25
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/generate-video-chapters">Video chapters</a>
|
|
26
26
|
*/
|
|
27
27
|
export declare function inVideoAIfeaturesGenerateChapters(client: FastpixCore, request: operations.UpdateMediaChaptersRequest, options?: RequestOptions): APIPromise<Result<operations.UpdateMediaChaptersResponse, FastpixError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
28
28
|
//# sourceMappingURL=inVideoAIfeaturesGenerateChapters.d.ts.map
|
|
@@ -59,11 +59,11 @@ const async_js_1 = require("../types/async.js");
|
|
|
59
59
|
* 2. Include the `chapters` parameter in the request body to enable.
|
|
60
60
|
* 3. The response contains the updated media data, confirming the changes made.
|
|
61
61
|
*
|
|
62
|
-
* You can use the <a href="https://docs.fastpix.
|
|
62
|
+
* 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.
|
|
63
63
|
*
|
|
64
64
|
* **Use case:** This is particularly useful when a user uploads a video and later decides to enable chapters without re-uploading the entire video.
|
|
65
65
|
*
|
|
66
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
66
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/generate-video-chapters">Video chapters</a>
|
|
67
67
|
*/
|
|
68
68
|
function inVideoAIfeaturesGenerateChapters(client, request, options) {
|
|
69
69
|
return new async_js_1.APIPromise($do(client, request, options));
|
|
@@ -40,13 +40,13 @@ import { Result } from "../types/fp.js";
|
|
|
40
40
|
*
|
|
41
41
|
* 3. Receive a response containing the unique id for the newly created media item.
|
|
42
42
|
*
|
|
43
|
-
* 4. Use the id in subsequent API calls, such as checking the status of the media with the <a href="https://docs.fastpix.
|
|
43
|
+
* 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.
|
|
44
44
|
*
|
|
45
|
-
* 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.
|
|
45
|
+
* 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>.
|
|
46
46
|
*
|
|
47
|
-
* After processing completes, monitor the events <a href="https://docs.fastpix.
|
|
47
|
+
* 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.
|
|
48
48
|
*
|
|
49
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
49
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/upload-videos-from-url">Upload videos from URL</a>
|
|
50
50
|
*/
|
|
51
51
|
export declare function inputVideoCreate(client: FastpixCore, request: models.CreateMediaRequest, options?: RequestOptions): APIPromise<Result<operations.CreateMediaResponse, FastpixError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
52
52
|
//# sourceMappingURL=inputVideoCreate.d.ts.map
|
|
@@ -81,13 +81,13 @@ const async_js_1 = require("../types/async.js");
|
|
|
81
81
|
*
|
|
82
82
|
* 3. Receive a response containing the unique id for the newly created media item.
|
|
83
83
|
*
|
|
84
|
-
* 4. Use the id in subsequent API calls, such as checking the status of the media with the <a href="https://docs.fastpix.
|
|
84
|
+
* 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.
|
|
85
85
|
*
|
|
86
|
-
* 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.
|
|
86
|
+
* 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>.
|
|
87
87
|
*
|
|
88
|
-
* After processing completes, monitor the events <a href="https://docs.fastpix.
|
|
88
|
+
* 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.
|
|
89
89
|
*
|
|
90
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
90
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/upload-videos-from-url">Upload videos from URL</a>
|
|
91
91
|
*/
|
|
92
92
|
function inputVideoCreate(client, request, options) {
|
|
93
93
|
return new async_js_1.APIPromise($do(client, request, options));
|
|
@@ -15,7 +15,7 @@ import { Result } from "../types/fp.js";
|
|
|
15
15
|
*
|
|
16
16
|
* > **NOTE**
|
|
17
17
|
* >
|
|
18
|
-
* > 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.
|
|
18
|
+
* > 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).
|
|
19
19
|
*
|
|
20
20
|
* #### How it works
|
|
21
21
|
*
|
|
@@ -23,19 +23,19 @@ import { Result } from "../types/fp.js";
|
|
|
23
23
|
*
|
|
24
24
|
* 2. The response includes an `uploadId` and a signed `url` for direct video file upload.
|
|
25
25
|
*
|
|
26
|
-
* 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.
|
|
26
|
+
* 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.)
|
|
27
27
|
*
|
|
28
28
|
* 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.
|
|
29
29
|
*
|
|
30
|
-
* After uploading, you can use the <a href="https://docs.fastpix.
|
|
30
|
+
* 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.
|
|
31
31
|
*
|
|
32
|
-
* To notify your application about the status of this API request check for the webhooks for <a href="https://docs.fastpix.
|
|
32
|
+
* 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>.
|
|
33
33
|
*
|
|
34
34
|
* #### Example
|
|
35
35
|
*
|
|
36
36
|
* 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.
|
|
37
37
|
*
|
|
38
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
38
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/upload-videos-directly">Upload videos directly</a>
|
|
39
39
|
*/
|
|
40
40
|
export declare function inputVideoUpload(client: FastpixCore, request?: operations.DirectUploadVideoMediaRequest | undefined, options?: RequestOptions): APIPromise<Result<operations.DirectUploadVideoMediaResponse, FastpixError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
41
41
|
//# sourceMappingURL=inputVideoUpload.d.ts.map
|
|
@@ -56,7 +56,7 @@ const async_js_1 = require("../types/async.js");
|
|
|
56
56
|
*
|
|
57
57
|
* > **NOTE**
|
|
58
58
|
* >
|
|
59
|
-
* > 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.
|
|
59
|
+
* > 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).
|
|
60
60
|
*
|
|
61
61
|
* #### How it works
|
|
62
62
|
*
|
|
@@ -64,19 +64,19 @@ const async_js_1 = require("../types/async.js");
|
|
|
64
64
|
*
|
|
65
65
|
* 2. The response includes an `uploadId` and a signed `url` for direct video file upload.
|
|
66
66
|
*
|
|
67
|
-
* 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.
|
|
67
|
+
* 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.)
|
|
68
68
|
*
|
|
69
69
|
* 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.
|
|
70
70
|
*
|
|
71
|
-
* After uploading, you can use the <a href="https://docs.fastpix.
|
|
71
|
+
* 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.
|
|
72
72
|
*
|
|
73
|
-
* To notify your application about the status of this API request check for the webhooks for <a href="https://docs.fastpix.
|
|
73
|
+
* 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>.
|
|
74
74
|
*
|
|
75
75
|
* #### Example
|
|
76
76
|
*
|
|
77
77
|
* 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.
|
|
78
78
|
*
|
|
79
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
79
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/upload-videos-directly">Upload videos directly</a>
|
|
80
80
|
*/
|
|
81
81
|
function inputVideoUpload(client, request, options) {
|
|
82
82
|
return new async_js_1.APIPromise($do(client, request, options));
|
|
@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
|
|
|
12
12
|
* Create a new stream
|
|
13
13
|
*
|
|
14
14
|
* @remarks
|
|
15
|
-
* Creates a new <a href="https://docs.fastpix.
|
|
15
|
+
* 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.
|
|
16
16
|
*
|
|
17
17
|
* 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.
|
|
18
18
|
*
|
|
@@ -22,13 +22,13 @@ import { Result } from "../types/fp.js";
|
|
|
22
22
|
*
|
|
23
23
|
* 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.
|
|
24
24
|
*
|
|
25
|
-
* 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.
|
|
25
|
+
* 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>.
|
|
26
26
|
*
|
|
27
27
|
* **Example:**
|
|
28
28
|
*
|
|
29
29
|
* 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.
|
|
30
30
|
*
|
|
31
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
31
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/how-to-livestream">How to live stream</a>
|
|
32
32
|
*/
|
|
33
33
|
export declare function liveStreamsCreate(client: FastpixCore, request: models.CreateLiveStreamRequest, options?: RequestOptions): APIPromise<Result<operations.CreateNewStreamResponse, FastpixError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
34
34
|
//# sourceMappingURL=liveStreamsCreate.d.ts.map
|
|
@@ -53,7 +53,7 @@ const async_js_1 = require("../types/async.js");
|
|
|
53
53
|
* Create a new stream
|
|
54
54
|
*
|
|
55
55
|
* @remarks
|
|
56
|
-
* Creates a new <a href="https://docs.fastpix.
|
|
56
|
+
* 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.
|
|
57
57
|
*
|
|
58
58
|
* 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.
|
|
59
59
|
*
|
|
@@ -63,13 +63,13 @@ const async_js_1 = require("../types/async.js");
|
|
|
63
63
|
*
|
|
64
64
|
* 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.
|
|
65
65
|
*
|
|
66
|
-
* 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.
|
|
66
|
+
* 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>.
|
|
67
67
|
*
|
|
68
68
|
* **Example:**
|
|
69
69
|
*
|
|
70
70
|
* 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.
|
|
71
71
|
*
|
|
72
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
72
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/how-to-livestream">How to live stream</a>
|
|
73
73
|
*/
|
|
74
74
|
function liveStreamsCreate(client, request, options) {
|
|
75
75
|
return new async_js_1.APIPromise($do(client, request, options));
|
|
@@ -13,13 +13,13 @@ import { Result } from "../types/fp.js";
|
|
|
13
13
|
* @remarks
|
|
14
14
|
* 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.
|
|
15
15
|
*
|
|
16
|
-
* 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.
|
|
16
|
+
* 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.
|
|
17
17
|
*
|
|
18
18
|
* #### Example
|
|
19
19
|
*
|
|
20
20
|
* 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.
|
|
21
21
|
*
|
|
22
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
22
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/manage-streams">Manage streams</a>
|
|
23
23
|
*/
|
|
24
24
|
export declare function liveStreamsDelete(client: FastpixCore, request: operations.DeleteLiveStreamRequest, options?: RequestOptions): APIPromise<Result<operations.DeleteLiveStreamResponse, FastpixError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
25
25
|
//# sourceMappingURL=liveStreamsDelete.d.ts.map
|
|
@@ -54,13 +54,13 @@ const async_js_1 = require("../types/async.js");
|
|
|
54
54
|
* @remarks
|
|
55
55
|
* 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.
|
|
56
56
|
*
|
|
57
|
-
* 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.
|
|
57
|
+
* 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.
|
|
58
58
|
*
|
|
59
59
|
* #### Example
|
|
60
60
|
*
|
|
61
61
|
* 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.
|
|
62
62
|
*
|
|
63
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
63
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/manage-streams">Manage streams</a>
|
|
64
64
|
*/
|
|
65
65
|
function liveStreamsDelete(client, request, options) {
|
|
66
66
|
return new async_js_1.APIPromise($do(client, request, options));
|
|
@@ -21,7 +21,7 @@ import { Result } from "../types/fp.js";
|
|
|
21
21
|
*
|
|
22
22
|
* 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.
|
|
23
23
|
*
|
|
24
|
-
* Related guide <a href="https://docs.fastpix.
|
|
24
|
+
* Related guide <a href="https://docs.fastpix.com/docs/manage-streams">Manage streams</a>
|
|
25
25
|
*/
|
|
26
26
|
export declare function liveStreamsEnable(client: FastpixCore, request: operations.EnableLiveStreamRequest, options?: RequestOptions): APIPromise<Result<operations.EnableLiveStreamResponse, FastpixError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
27
27
|
//# sourceMappingURL=liveStreamsEnable.d.ts.map
|
|
@@ -62,7 +62,7 @@ const async_js_1 = require("../types/async.js");
|
|
|
62
62
|
*
|
|
63
63
|
* 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.
|
|
64
64
|
*
|
|
65
|
-
* Related guide <a href="https://docs.fastpix.
|
|
65
|
+
* Related guide <a href="https://docs.fastpix.com/docs/manage-streams">Manage streams</a>
|
|
66
66
|
*/
|
|
67
67
|
function liveStreamsEnable(client, request, options) {
|
|
68
68
|
return new async_js_1.APIPromise($do(client, request, options));
|