api.md

Streaming

Types:

from gcore.types.streaming import CreateVideo, Video

AITasks

Types:

from gcore.types.streaming import (
    AIContentmoderationHardnudity,
    AIContentmoderationNsfw,
    AIContentmoderationSoftnudity,
    AIContentmoderationSport,
    AITask,
    AITaskCreateResponse,
    AITaskCancelResponse,
    AITaskGetResponse,
    AITaskGetAISettingsResponse,
)

Methods:

• client.streaming.ai_tasks.create(**params) -> AITaskCreateResponse
• client.streaming.ai_tasks.list(**params) -> SyncPageStreamingAI[AITask]
• client.streaming.ai_tasks.cancel(task_id) -> AITaskCancelResponse
• client.streaming.ai_tasks.get(task_id) -> AITaskGetResponse
• client.streaming.ai_tasks.get_ai_settings(**params) -> AITaskGetAISettingsResponse

Broadcasts

Types:

from gcore.types.streaming import Broadcast, BroadcastSpectatorsCount

Methods:

• client.streaming.broadcasts.create(**params) -> None
• client.streaming.broadcasts.update(broadcast_id, **params) -> Broadcast
• client.streaming.broadcasts.list(**params) -> SyncPageStreaming[Broadcast]
• client.streaming.broadcasts.delete(broadcast_id) -> None
• client.streaming.broadcasts.get(broadcast_id) -> Broadcast
• client.streaming.broadcasts.get_spectators_count(broadcast_id) -> BroadcastSpectatorsCount

Directories

Types:

from gcore.types.streaming import (
    DirectoriesTree,
    DirectoryBase,
    DirectoryItem,
    DirectoryVideo,
    DirectoryGetResponse,
)

Methods:

• client.streaming.directories.create(**params) -> DirectoryBase
• client.streaming.directories.update(directory_id, **params) -> DirectoryBase
• client.streaming.directories.delete(directory_id) -> None
• client.streaming.directories.get(directory_id) -> DirectoryGetResponse
• client.streaming.directories.get_tree() -> DirectoriesTree

Players

Types:

from gcore.types.streaming import Player

Methods:

• client.streaming.players.create(**params) -> None
• client.streaming.players.update(player_id, **params) -> Player
• client.streaming.players.list(**params) -> SyncPageStreaming[Player]
• client.streaming.players.delete(player_id) -> None
• client.streaming.players.get(player_id) -> Player
• client.streaming.players.preview(player_id) -> None

QualitySets

Types:

from gcore.types.streaming import QualitySets

Methods:

• client.streaming.quality_sets.list() -> QualitySets
• client.streaming.quality_sets.set_default(**params) -> QualitySets

Playlists

Types:

from gcore.types.streaming import Playlist, PlaylistCreated, PlaylistVideo

Methods:

• client.streaming.playlists.create(**params) -> PlaylistCreated
• client.streaming.playlists.update(playlist_id, **params) -> Playlist
• client.streaming.playlists.list(**params) -> SyncPageStreaming[Playlist]
• client.streaming.playlists.delete(playlist_id) -> None
• client.streaming.playlists.get(playlist_id) -> Playlist

Videos

Types:

from gcore.types.streaming.playlists import VideoListResponse

Methods:

• client.streaming.playlists.videos.list(playlist_id) -> VideoListResponse

Videos

Types:

from gcore.types.streaming import (
    DirectUploadParameters,
    Subtitle,
    SubtitleBase,
    SubtitleBody,
    SubtitleUpdated,
    VideoCreateResponse,
    VideoCreateMultipleResponse,
)

Methods:

• client.streaming.videos.create(**params) -> VideoCreateResponse
• client.streaming.videos.update(video_id, **params) -> Video
• client.streaming.videos.list(**params) -> SyncPageStreaming[Video]
• client.streaming.videos.delete(video_id) -> None
• client.streaming.videos.create_multiple(**params) -> VideoCreateMultipleResponse
• client.streaming.videos.get(video_id) -> Video
• client.streaming.videos.get_parameters_for_direct_upload(video_id) -> DirectUploadParameters
• client.streaming.videos.list_names(**params) -> None

Subtitles

Types:

from gcore.types.streaming.videos import SubtitleListResponse

Methods:

• client.streaming.videos.subtitles.create(video_id, **params) -> Subtitle
• client.streaming.videos.subtitles.update(id, *, video_id, **params) -> SubtitleBase
• client.streaming.videos.subtitles.list(video_id) -> SubtitleListResponse
• client.streaming.videos.subtitles.delete(id, *, video_id) -> None
• client.streaming.videos.subtitles.get(id, *, video_id) -> Subtitle

Streams

Types:

from gcore.types.streaming import Stream, StreamStartRecordingResponse

Methods:

• client.streaming.streams.create(**params) -> Stream
• client.streaming.streams.update(stream_id, **params) -> Stream
• client.streaming.streams.list(**params) -> SyncPageStreaming[Stream]
• client.streaming.streams.delete(stream_id) -> None
• client.streaming.streams.clear_dvr(stream_id) -> None
• client.streaming.streams.get(stream_id) -> Stream
• client.streaming.streams.start_recording(stream_id) -> StreamStartRecordingResponse
• client.streaming.streams.stop_recording(stream_id) -> Video

Clips

Types:

from gcore.types.streaming.streams import Clip, ClipListResponse

Methods:

• client.streaming.streams.clips.create(stream_id, **params) -> Clip
• client.streaming.streams.clips.list(stream_id) -> ClipListResponse

Overlays

Types:

from gcore.types.streaming.streams import (
    Overlay,
    OverlayCreateResponse,
    OverlayListResponse,
    OverlayUpdateMultipleResponse,
)

Methods:

• client.streaming.streams.overlays.create(stream_id, **params) -> OverlayCreateResponse
• client.streaming.streams.overlays.update(overlay_id, *, stream_id, **params) -> Overlay
• client.streaming.streams.overlays.list(stream_id) -> OverlayListResponse
• client.streaming.streams.overlays.delete(overlay_id, *, stream_id) -> None
• client.streaming.streams.overlays.get(overlay_id, *, stream_id) -> Overlay
• client.streaming.streams.overlays.update_multiple(stream_id, **params) -> OverlayUpdateMultipleResponse

Restreams

Types:

from gcore.types.streaming import Restream

Methods:

• client.streaming.restreams.create(**params) -> None
• client.streaming.restreams.update(restream_id, **params) -> Restream
• client.streaming.restreams.list(**params) -> SyncPageStreaming[Restream]
• client.streaming.restreams.delete(restream_id) -> None
• client.streaming.restreams.get(restream_id) -> Restream

Statistics

Types:

from gcore.types.streaming import (
    Ffprobes,
    MaxStreamSeries,
    PopularVideos,
    StorageSeries,
    StreamSeries,
    UniqueViewers,
    UniqueViewersCDN,
    Views,
    ViewsByBrowser,
    ViewsByCountry,
    ViewsByHostname,
    ViewsByOperatingSystem,
    ViewsByReferer,
    ViewsByRegion,
    ViewsHeatmap,
    VodStatisticsSeries,
    VodTotalStreamDurationSeries,
    StatisticGetLiveUniqueViewersResponse,
    StatisticGetVodWatchTimeTotalCDNResponse,
)

Methods:

• client.streaming.statistics.get_ffprobes(**params) -> Ffprobes
• client.streaming.statistics.get_live_unique_viewers(**params) -> StatisticGetLiveUniqueViewersResponse
• client.streaming.statistics.get_live_watch_time_cdn(**params) -> StreamSeries
• client.streaming.statistics.get_live_watch_time_total_cdn(**params) -> VodTotalStreamDurationSeries
• client.streaming.statistics.get_max_streams_series(**params) -> MaxStreamSeries
• client.streaming.statistics.get_popular_videos(**params) -> PopularVideos
• client.streaming.statistics.get_storage_series(**params) -> StorageSeries
• client.streaming.statistics.get_stream_series(**params) -> StreamSeries
• client.streaming.statistics.get_unique_viewers(**params) -> UniqueViewers
• client.streaming.statistics.get_unique_viewers_cdn(**params) -> UniqueViewersCDN
• client.streaming.statistics.get_views(**params) -> Views
• client.streaming.statistics.get_views_by_browsers(**params) -> ViewsByBrowser
• client.streaming.statistics.get_views_by_country(**params) -> ViewsByCountry
• client.streaming.statistics.get_views_by_hostname(**params) -> ViewsByHostname
• client.streaming.statistics.get_views_by_operating_system(**params) -> ViewsByOperatingSystem
• client.streaming.statistics.get_views_by_referer(**params) -> ViewsByReferer
• client.streaming.statistics.get_views_by_region(**params) -> ViewsByRegion
• client.streaming.statistics.get_views_heatmap(**params) -> ViewsHeatmap
• client.streaming.statistics.get_vod_storage_volume(**params) -> VodStatisticsSeries
• client.streaming.statistics.get_vod_transcoding_duration(**params) -> VodStatisticsSeries
• client.streaming.statistics.get_vod_unique_viewers_cdn(**params) -> VodStatisticsSeries
• client.streaming.statistics.get_vod_watch_time_cdn(**params) -> VodStatisticsSeries
• client.streaming.statistics.get_vod_watch_time_total_cdn(**params) -> StatisticGetVodWatchTimeTotalCDNResponse