nominal-api 0.1239.0

API bindings for the Nominal platform
Documentation
use conjure_http::endpoint;
/// Upon ingestion, every video is split into smaller segments. The Video Segment Service manages operations on videos
/// at the segment-level.
#[conjure_http::conjure_client(name = "VideoSegmentService")]
pub trait VideoSegmentService<
    #[response_body]
    I: Iterator<
            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
        >,
> {
    #[endpoint(
        method = POST,
        path = "/video/v1/videos/{videoRid}/create-segments",
        name = "createSegments",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    fn create_segments(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "videoRid", encoder = conjure_http::client::conjure::PlainEncoder)]
        video_rid: &super::super::super::super::objects::api::rids::VideoRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::scout::video::api::CreateSegmentsRequest,
    ) -> Result<(), conjure_http::private::Error>;
    #[endpoint(
        method = POST,
        path = "/video/v1/videos/{videoRid}/{videoFileRid}/create-segments",
        name = "createVideoFileSegments",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn create_video_file_segments(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "videoRid", encoder = conjure_http::client::conjure::PlainEncoder)]
        video_rid: &super::super::super::super::objects::api::rids::VideoRid,
        #[path(
            name = "videoFileRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        video_file_rid: &super::super::super::super::objects::api::rids::VideoFileRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::scout::video::api::CreateSegmentsRequest,
    ) -> Result<
        super::super::super::super::objects::scout::video::api::CreateSegmentsResponse,
        conjure_http::private::Error,
    >;
    /// Creates segments for a video stream. Similar to createVideoFileSegments but for streaming video.
    #[endpoint(
        method = POST,
        path = "/video/v1/videos/{videoRid}/streams/{streamUuid}/create-segments",
        name = "createVideoStreamSegments",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn create_video_stream_segments(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "videoRid", encoder = conjure_http::client::conjure::PlainEncoder)]
        video_rid: &super::super::super::super::objects::api::rids::VideoRid,
        #[path(
            name = "streamUuid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        stream_uuid: conjure_object::Uuid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::scout::video::api::CreateSegmentsRequest,
    ) -> Result<
        super::super::super::super::objects::scout::video::api::CreateSegmentsResponse,
        conjure_http::private::Error,
    >;
    /// Creates segments for a dataset file video. Used for channel-based video ingestion.
    /// Internal use only.
    #[endpoint(
        method = POST,
        path = "/video/v2/videos/create-segments",
        name = "createSegmentsV2",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn create_segments_v2(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::scout::video::api::CreateSegmentsV2Request,
    ) -> Result<
        super::super::super::super::objects::scout::video::api::CreateSegmentsV2Response,
        conjure_http::private::Error,
    >;
    /// Creates segments for a channel-backed live video stream. Internal use only.
    #[endpoint(
        method = POST,
        path = "/video/v2/videos/streams/{streamUuid}/create-segments",
        name = "createStreamSegmentsV2",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn create_stream_segments_v2(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "streamUuid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        stream_uuid: conjure_object::Uuid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::scout::video::api::CreateStreamSegmentsV2Request,
    ) -> Result<
        super::super::super::super::objects::scout::video::api::CreateSegmentsV2Response,
        conjure_http::private::Error,
    >;
    /// Returns metadata for the segment within a video containing the requested absolute timestamp.
    #[endpoint(
        method = POST,
        path = "/video/v1/videos/{videoRid}/get-segment-by-timestamp",
        name = "getSegmentByTimestamp",
        accept = conjure_http::client::conjure::CollectionResponseDeserializer
    )]
    fn get_segment_by_timestamp(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "videoRid", encoder = conjure_http::client::conjure::PlainEncoder)]
        video_rid: &super::super::super::super::objects::api::rids::VideoRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::scout::video::api::GetSegmentByTimestampRequest,
    ) -> Result<
        Option<super::super::super::super::objects::scout::video::api::Segment>,
        conjure_http::private::Error,
    >;
}
/// Upon ingestion, every video is split into smaller segments. The Video Segment Service manages operations on videos
/// at the segment-level.
#[conjure_http::conjure_client(name = "VideoSegmentService")]
pub trait AsyncVideoSegmentService<
    #[response_body]
    I: conjure_http::private::Stream<
            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
        >,
> {
    #[endpoint(
        method = POST,
        path = "/video/v1/videos/{videoRid}/create-segments",
        name = "createSegments",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn create_segments(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "videoRid", encoder = conjure_http::client::conjure::PlainEncoder)]
        video_rid: &super::super::super::super::objects::api::rids::VideoRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::scout::video::api::CreateSegmentsRequest,
    ) -> Result<(), conjure_http::private::Error>;
    #[endpoint(
        method = POST,
        path = "/video/v1/videos/{videoRid}/{videoFileRid}/create-segments",
        name = "createVideoFileSegments",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn create_video_file_segments(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "videoRid", encoder = conjure_http::client::conjure::PlainEncoder)]
        video_rid: &super::super::super::super::objects::api::rids::VideoRid,
        #[path(
            name = "videoFileRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        video_file_rid: &super::super::super::super::objects::api::rids::VideoFileRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::scout::video::api::CreateSegmentsRequest,
    ) -> Result<
        super::super::super::super::objects::scout::video::api::CreateSegmentsResponse,
        conjure_http::private::Error,
    >;
    /// Creates segments for a video stream. Similar to createVideoFileSegments but for streaming video.
    #[endpoint(
        method = POST,
        path = "/video/v1/videos/{videoRid}/streams/{streamUuid}/create-segments",
        name = "createVideoStreamSegments",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn create_video_stream_segments(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "videoRid", encoder = conjure_http::client::conjure::PlainEncoder)]
        video_rid: &super::super::super::super::objects::api::rids::VideoRid,
        #[path(
            name = "streamUuid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        stream_uuid: conjure_object::Uuid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::scout::video::api::CreateSegmentsRequest,
    ) -> Result<
        super::super::super::super::objects::scout::video::api::CreateSegmentsResponse,
        conjure_http::private::Error,
    >;
    /// Creates segments for a dataset file video. Used for channel-based video ingestion.
    /// Internal use only.
    #[endpoint(
        method = POST,
        path = "/video/v2/videos/create-segments",
        name = "createSegmentsV2",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn create_segments_v2(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::scout::video::api::CreateSegmentsV2Request,
    ) -> Result<
        super::super::super::super::objects::scout::video::api::CreateSegmentsV2Response,
        conjure_http::private::Error,
    >;
    /// Creates segments for a channel-backed live video stream. Internal use only.
    #[endpoint(
        method = POST,
        path = "/video/v2/videos/streams/{streamUuid}/create-segments",
        name = "createStreamSegmentsV2",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn create_stream_segments_v2(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "streamUuid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        stream_uuid: conjure_object::Uuid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::scout::video::api::CreateStreamSegmentsV2Request,
    ) -> Result<
        super::super::super::super::objects::scout::video::api::CreateSegmentsV2Response,
        conjure_http::private::Error,
    >;
    /// Returns metadata for the segment within a video containing the requested absolute timestamp.
    #[endpoint(
        method = POST,
        path = "/video/v1/videos/{videoRid}/get-segment-by-timestamp",
        name = "getSegmentByTimestamp",
        accept = conjure_http::client::conjure::CollectionResponseDeserializer
    )]
    async fn get_segment_by_timestamp(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "videoRid", encoder = conjure_http::client::conjure::PlainEncoder)]
        video_rid: &super::super::super::super::objects::api::rids::VideoRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::scout::video::api::GetSegmentByTimestampRequest,
    ) -> Result<
        Option<super::super::super::super::objects::scout::video::api::Segment>,
        conjure_http::private::Error,
    >;
}
/// Upon ingestion, every video is split into smaller segments. The Video Segment Service manages operations on videos
/// at the segment-level.
#[conjure_http::conjure_client(name = "VideoSegmentService", local)]
pub trait LocalAsyncVideoSegmentService<
    #[response_body]
    I: conjure_http::private::Stream<
            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
        >,
> {
    #[endpoint(
        method = POST,
        path = "/video/v1/videos/{videoRid}/create-segments",
        name = "createSegments",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn create_segments(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "videoRid", encoder = conjure_http::client::conjure::PlainEncoder)]
        video_rid: &super::super::super::super::objects::api::rids::VideoRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::scout::video::api::CreateSegmentsRequest,
    ) -> Result<(), conjure_http::private::Error>;
    #[endpoint(
        method = POST,
        path = "/video/v1/videos/{videoRid}/{videoFileRid}/create-segments",
        name = "createVideoFileSegments",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn create_video_file_segments(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "videoRid", encoder = conjure_http::client::conjure::PlainEncoder)]
        video_rid: &super::super::super::super::objects::api::rids::VideoRid,
        #[path(
            name = "videoFileRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        video_file_rid: &super::super::super::super::objects::api::rids::VideoFileRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::scout::video::api::CreateSegmentsRequest,
    ) -> Result<
        super::super::super::super::objects::scout::video::api::CreateSegmentsResponse,
        conjure_http::private::Error,
    >;
    /// Creates segments for a video stream. Similar to createVideoFileSegments but for streaming video.
    #[endpoint(
        method = POST,
        path = "/video/v1/videos/{videoRid}/streams/{streamUuid}/create-segments",
        name = "createVideoStreamSegments",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn create_video_stream_segments(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "videoRid", encoder = conjure_http::client::conjure::PlainEncoder)]
        video_rid: &super::super::super::super::objects::api::rids::VideoRid,
        #[path(
            name = "streamUuid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        stream_uuid: conjure_object::Uuid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::scout::video::api::CreateSegmentsRequest,
    ) -> Result<
        super::super::super::super::objects::scout::video::api::CreateSegmentsResponse,
        conjure_http::private::Error,
    >;
    /// Creates segments for a dataset file video. Used for channel-based video ingestion.
    /// Internal use only.
    #[endpoint(
        method = POST,
        path = "/video/v2/videos/create-segments",
        name = "createSegmentsV2",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn create_segments_v2(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::scout::video::api::CreateSegmentsV2Request,
    ) -> Result<
        super::super::super::super::objects::scout::video::api::CreateSegmentsV2Response,
        conjure_http::private::Error,
    >;
    /// Creates segments for a channel-backed live video stream. Internal use only.
    #[endpoint(
        method = POST,
        path = "/video/v2/videos/streams/{streamUuid}/create-segments",
        name = "createStreamSegmentsV2",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn create_stream_segments_v2(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "streamUuid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        stream_uuid: conjure_object::Uuid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::scout::video::api::CreateStreamSegmentsV2Request,
    ) -> Result<
        super::super::super::super::objects::scout::video::api::CreateSegmentsV2Response,
        conjure_http::private::Error,
    >;
    /// Returns metadata for the segment within a video containing the requested absolute timestamp.
    #[endpoint(
        method = POST,
        path = "/video/v1/videos/{videoRid}/get-segment-by-timestamp",
        name = "getSegmentByTimestamp",
        accept = conjure_http::client::conjure::CollectionResponseDeserializer
    )]
    async fn get_segment_by_timestamp(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "videoRid", encoder = conjure_http::client::conjure::PlainEncoder)]
        video_rid: &super::super::super::super::objects::api::rids::VideoRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::scout::video::api::GetSegmentByTimestampRequest,
    ) -> Result<
        Option<super::super::super::super::objects::scout::video::api::Segment>,
        conjure_http::private::Error,
    >;
}