From 541c182b778fd423a20fd31de0c22ac24a0cddc2 Mon Sep 17 00:00:00 2001 From: Phil Cluff <578330+philcluff@users.noreply.github.com> Date: Mon, 4 Dec 2023 11:44:48 +0000 Subject: [PATCH] Prep for 5.1.0 (#51) * Regen from latest openapi spec * Remember to bump version --- api_web_inputs.go | 622 ++++++++++++++++++ client.go | 2 + configuration.go | 2 +- docs/Asset.md | 4 +- docs/BreakdownValue.md | 1 + docs/CreateAssetRequest.md | 6 +- docs/CreateLiveStreamRequest.md | 2 +- docs/CreateSimulcastTargetRequest.md | 2 +- docs/CreateUploadRequest.md | 2 +- docs/CreateWebInputRequest.md | 18 + docs/Error.md | 2 +- docs/GetMetricTimeseriesDataResponse.md | 1 + ...nitoringHistogramTimeseriesResponseMeta.md | 1 + docs/GetOverallValuesResponse.md | 1 + ...RealTimeHistogramTimeseriesResponseMeta.md | 1 + docs/IncidentResponse.md | 1 + docs/InputSettings.md | 2 +- docs/Insight.md | 1 + docs/LaunchWebInputResponse.md | 10 + docs/ListBreakdownValuesResponse.md | 1 + docs/ListBreakdownValuesResponseMeta.md | 11 + docs/ListInsightsResponse.md | 1 + docs/ListWebInputsResponse.md | 10 + docs/LiveStream.md | 8 +- docs/MonitoringBreakdownValue.md | 1 + docs/OverallValues.md | 1 + docs/RealTimeBreakdownValue.md | 1 + docs/ReloadWebInputResponse.md | 10 + docs/Score.md | 5 + docs/ShutdownWebInputResponse.md | 10 + docs/SpacesApi.md | 2 +- docs/UpdateLiveStreamRequest.md | 2 +- docs/UpdateWebInputUrlRequest.md | 10 + docs/VideoView.md | 2 + docs/VideoViewEvent.md | 1 + docs/VideoViewResponse.md | 1 + docs/WebInput.md | 18 + docs/WebInputResponse.md | 10 + docs/WebInputsApi.md | 249 +++++++ model_asset.go | 4 +- model_asset_non_standard_input_reasons.go | 2 +- model_asset_static_renditions.go | 2 +- model_breakdown_value.go | 11 +- model_create_asset_request.go | 6 +- model_create_live_stream_request.go | 2 +- model_create_simulcast_target_request.go | 2 +- model_create_upload_request.go | 2 +- model_create_web_input_request.go | 24 + model_error.go | 2 +- model_get_metric_timeseries_data_response.go | 7 +- ...ring_histogram_timeseries_response_meta.go | 3 +- model_get_overall_values_response.go | 7 +- ...time_histogram_timeseries_response_meta.go | 3 +- model_incident_response.go | 5 +- model_input_settings.go | 2 +- model_insight.go | 1 + model_launch_web_input_response.go | 8 + model_list_breakdown_values_response.go | 7 +- model_list_breakdown_values_response_meta.go | 9 + model_list_insights_response.go | 7 +- model_list_web_inputs_response.go | 8 + model_live_stream.go | 8 +- model_monitoring_breakdown_value.go | 1 + model_overall_values.go | 9 +- model_playback_policy.go | 2 +- model_real_time_breakdown_value.go | 1 + model_reload_web_input_response.go | 8 + model_score.go | 17 +- model_shutdown_web_input_response.go | 8 + model_update_live_stream_request.go | 2 +- model_update_web_input_url_request.go | 9 + model_video_view.go | 2 + model_video_view_event.go | 9 +- model_video_view_response.go | 5 +- model_web_input.go | 24 + model_web_input_response.go | 8 + 76 files changed, 1200 insertions(+), 72 deletions(-) create mode 100644 api_web_inputs.go create mode 100644 docs/CreateWebInputRequest.md create mode 100644 docs/LaunchWebInputResponse.md create mode 100644 docs/ListBreakdownValuesResponseMeta.md create mode 100644 docs/ListWebInputsResponse.md create mode 100644 docs/ReloadWebInputResponse.md create mode 100644 docs/ShutdownWebInputResponse.md create mode 100644 docs/UpdateWebInputUrlRequest.md create mode 100644 docs/WebInput.md create mode 100644 docs/WebInputResponse.md create mode 100644 docs/WebInputsApi.md create mode 100644 model_create_web_input_request.go create mode 100644 model_launch_web_input_response.go create mode 100644 model_list_breakdown_values_response_meta.go create mode 100644 model_list_web_inputs_response.go create mode 100644 model_reload_web_input_response.go create mode 100644 model_shutdown_web_input_response.go create mode 100644 model_update_web_input_url_request.go create mode 100644 model_web_input.go create mode 100644 model_web_input_response.go diff --git a/api_web_inputs.go b/api_web_inputs.go new file mode 100644 index 0000000..2bca9ea --- /dev/null +++ b/api_web_inputs.go @@ -0,0 +1,622 @@ +// Mux Go - Copyright 2019 Mux Inc. +// NOTE: This file is auto generated. Do not edit this file manually. + +package muxgo + +import ( + "fmt" + "io/ioutil" + "net/url" + "strings" +) + +type WebInputsApiService service + +func (a *WebInputsApiService) CreateWebInput(createWebInputRequest CreateWebInputRequest, opts ...APIOption) (WebInputResponse, error) { + var ( + localVarAPIOptions = new(APIOptions) + localVarHttpMethod = strings.ToUpper("Post") + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue WebInputResponse + ) + + for _, opt := range opts { + opt(localVarAPIOptions) + } + + // create path and map variables + localVarPath := a.client.cfg.basePath + "/video/v1/web-inputs" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + + // to determine the Content-Type header + localVarHttpContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHttpContentType := selectHeaderContentType(localVarHttpContentTypes) + if localVarHttpContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHttpContentType + } + + // to determine the Accept header + localVarHttpHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts) + if localVarHttpHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHttpHeaderAccept + } + // body params + localVarPostBody = &createWebInputRequest + + r, err := a.client.prepareRequest(localVarAPIOptions, localVarPath, localVarHttpMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, err + } + + localVarHttpResponse, err := a.client.callAPI(r) + if err != nil || localVarHttpResponse == nil { + return localVarReturnValue, err + } + + localVarBody, err := ioutil.ReadAll(localVarHttpResponse.Body) + localVarHttpResponse.Body.Close() + if err != nil { + return localVarReturnValue, err + } + + // Check for common HTTP error status codes + err = CheckForHttpError(localVarHttpResponse.StatusCode, localVarBody) + if err != nil { + return localVarReturnValue, err + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHttpResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, newErr + } + + return localVarReturnValue, nil +} + +func (a *WebInputsApiService) DeleteWebInput(wEBINPUTID string, opts ...APIOption) error { + var ( + localVarAPIOptions = new(APIOptions) + localVarHttpMethod = strings.ToUpper("Delete") + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + ) + + for _, opt := range opts { + opt(localVarAPIOptions) + } + + // create path and map variables + localVarPath := a.client.cfg.basePath + "/video/v1/web-inputs/{WEB_INPUT_ID}" + localVarPath = strings.Replace(localVarPath, "{"+"WEB_INPUT_ID"+"}", fmt.Sprintf("%v", wEBINPUTID), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + + // to determine the Content-Type header + localVarHttpContentTypes := []string{} + + // set Content-Type header + localVarHttpContentType := selectHeaderContentType(localVarHttpContentTypes) + if localVarHttpContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHttpContentType + } + + // to determine the Accept header + localVarHttpHeaderAccepts := []string{} + + // set Accept header + localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts) + if localVarHttpHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHttpHeaderAccept + } + + r, err := a.client.prepareRequest(localVarAPIOptions, localVarPath, localVarHttpMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return err + } + + localVarHttpResponse, err := a.client.callAPI(r) + if err != nil || localVarHttpResponse == nil { + return err + } + + localVarBody, err := ioutil.ReadAll(localVarHttpResponse.Body) + localVarHttpResponse.Body.Close() + if err != nil { + return err + } + + // Check for common HTTP error status codes + err = CheckForHttpError(localVarHttpResponse.StatusCode, localVarBody) + if err != nil { + return err + } + + return nil +} + +func (a *WebInputsApiService) GetWebInput(wEBINPUTID string, opts ...APIOption) (WebInputResponse, error) { + var ( + localVarAPIOptions = new(APIOptions) + localVarHttpMethod = strings.ToUpper("Get") + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue WebInputResponse + ) + + for _, opt := range opts { + opt(localVarAPIOptions) + } + + // create path and map variables + localVarPath := a.client.cfg.basePath + "/video/v1/web-inputs/{WEB_INPUT_ID}" + localVarPath = strings.Replace(localVarPath, "{"+"WEB_INPUT_ID"+"}", fmt.Sprintf("%v", wEBINPUTID), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + + // to determine the Content-Type header + localVarHttpContentTypes := []string{} + + // set Content-Type header + localVarHttpContentType := selectHeaderContentType(localVarHttpContentTypes) + if localVarHttpContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHttpContentType + } + + // to determine the Accept header + localVarHttpHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts) + if localVarHttpHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHttpHeaderAccept + } + + r, err := a.client.prepareRequest(localVarAPIOptions, localVarPath, localVarHttpMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, err + } + + localVarHttpResponse, err := a.client.callAPI(r) + if err != nil || localVarHttpResponse == nil { + return localVarReturnValue, err + } + + localVarBody, err := ioutil.ReadAll(localVarHttpResponse.Body) + localVarHttpResponse.Body.Close() + if err != nil { + return localVarReturnValue, err + } + + // Check for common HTTP error status codes + err = CheckForHttpError(localVarHttpResponse.StatusCode, localVarBody) + if err != nil { + return localVarReturnValue, err + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHttpResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, newErr + } + + return localVarReturnValue, nil +} + +func (a *WebInputsApiService) LaunchWebInput(wEBINPUTID string, opts ...APIOption) (LaunchWebInputResponse, error) { + var ( + localVarAPIOptions = new(APIOptions) + localVarHttpMethod = strings.ToUpper("Put") + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue LaunchWebInputResponse + ) + + for _, opt := range opts { + opt(localVarAPIOptions) + } + + // create path and map variables + localVarPath := a.client.cfg.basePath + "/video/v1/web-inputs/{WEB_INPUT_ID}/launch" + localVarPath = strings.Replace(localVarPath, "{"+"WEB_INPUT_ID"+"}", fmt.Sprintf("%v", wEBINPUTID), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + + // to determine the Content-Type header + localVarHttpContentTypes := []string{} + + // set Content-Type header + localVarHttpContentType := selectHeaderContentType(localVarHttpContentTypes) + if localVarHttpContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHttpContentType + } + + // to determine the Accept header + localVarHttpHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts) + if localVarHttpHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHttpHeaderAccept + } + + r, err := a.client.prepareRequest(localVarAPIOptions, localVarPath, localVarHttpMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, err + } + + localVarHttpResponse, err := a.client.callAPI(r) + if err != nil || localVarHttpResponse == nil { + return localVarReturnValue, err + } + + localVarBody, err := ioutil.ReadAll(localVarHttpResponse.Body) + localVarHttpResponse.Body.Close() + if err != nil { + return localVarReturnValue, err + } + + // Check for common HTTP error status codes + err = CheckForHttpError(localVarHttpResponse.StatusCode, localVarBody) + if err != nil { + return localVarReturnValue, err + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHttpResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, newErr + } + + return localVarReturnValue, nil +} + +type ListWebInputsParams struct { + Limit int32 + Page int32 +} + +// ListWebInputs optionally accepts the APIOption of WithParams(*ListWebInputsParams). +func (a *WebInputsApiService) ListWebInputs(opts ...APIOption) (ListWebInputsResponse, error) { + var ( + localVarAPIOptions = new(APIOptions) + localVarHttpMethod = strings.ToUpper("Get") + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue ListWebInputsResponse + ) + + for _, opt := range opts { + opt(localVarAPIOptions) + } + + localVarOptionals, ok := localVarAPIOptions.params.(*ListWebInputsParams) + if localVarAPIOptions.params != nil && !ok { + return localVarReturnValue, reportError("provided params were not of type *ListWebInputsParams") + } + + // create path and map variables + localVarPath := a.client.cfg.basePath + "/video/v1/web-inputs" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + + if localVarOptionals != nil && isSet(localVarOptionals.Limit) { + localVarQueryParams.Add("limit", parameterToString(localVarOptionals.Limit, "")) + } + if localVarOptionals != nil && isSet(localVarOptionals.Page) { + localVarQueryParams.Add("page", parameterToString(localVarOptionals.Page, "")) + } + // to determine the Content-Type header + localVarHttpContentTypes := []string{} + + // set Content-Type header + localVarHttpContentType := selectHeaderContentType(localVarHttpContentTypes) + if localVarHttpContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHttpContentType + } + + // to determine the Accept header + localVarHttpHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts) + if localVarHttpHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHttpHeaderAccept + } + + r, err := a.client.prepareRequest(localVarAPIOptions, localVarPath, localVarHttpMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, err + } + + localVarHttpResponse, err := a.client.callAPI(r) + if err != nil || localVarHttpResponse == nil { + return localVarReturnValue, err + } + + localVarBody, err := ioutil.ReadAll(localVarHttpResponse.Body) + localVarHttpResponse.Body.Close() + if err != nil { + return localVarReturnValue, err + } + + // Check for common HTTP error status codes + err = CheckForHttpError(localVarHttpResponse.StatusCode, localVarBody) + if err != nil { + return localVarReturnValue, err + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHttpResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, newErr + } + + return localVarReturnValue, nil +} + +func (a *WebInputsApiService) ReloadWebInput(wEBINPUTID string, opts ...APIOption) (ReloadWebInputResponse, error) { + var ( + localVarAPIOptions = new(APIOptions) + localVarHttpMethod = strings.ToUpper("Put") + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue ReloadWebInputResponse + ) + + for _, opt := range opts { + opt(localVarAPIOptions) + } + + // create path and map variables + localVarPath := a.client.cfg.basePath + "/video/v1/web-inputs/{WEB_INPUT_ID}/reload" + localVarPath = strings.Replace(localVarPath, "{"+"WEB_INPUT_ID"+"}", fmt.Sprintf("%v", wEBINPUTID), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + + // to determine the Content-Type header + localVarHttpContentTypes := []string{} + + // set Content-Type header + localVarHttpContentType := selectHeaderContentType(localVarHttpContentTypes) + if localVarHttpContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHttpContentType + } + + // to determine the Accept header + localVarHttpHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts) + if localVarHttpHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHttpHeaderAccept + } + + r, err := a.client.prepareRequest(localVarAPIOptions, localVarPath, localVarHttpMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, err + } + + localVarHttpResponse, err := a.client.callAPI(r) + if err != nil || localVarHttpResponse == nil { + return localVarReturnValue, err + } + + localVarBody, err := ioutil.ReadAll(localVarHttpResponse.Body) + localVarHttpResponse.Body.Close() + if err != nil { + return localVarReturnValue, err + } + + // Check for common HTTP error status codes + err = CheckForHttpError(localVarHttpResponse.StatusCode, localVarBody) + if err != nil { + return localVarReturnValue, err + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHttpResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, newErr + } + + return localVarReturnValue, nil +} + +func (a *WebInputsApiService) ShutdownWebInput(wEBINPUTID string, opts ...APIOption) (ShutdownWebInputResponse, error) { + var ( + localVarAPIOptions = new(APIOptions) + localVarHttpMethod = strings.ToUpper("Put") + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue ShutdownWebInputResponse + ) + + for _, opt := range opts { + opt(localVarAPIOptions) + } + + // create path and map variables + localVarPath := a.client.cfg.basePath + "/video/v1/web-inputs/{WEB_INPUT_ID}/shutdown" + localVarPath = strings.Replace(localVarPath, "{"+"WEB_INPUT_ID"+"}", fmt.Sprintf("%v", wEBINPUTID), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + + // to determine the Content-Type header + localVarHttpContentTypes := []string{} + + // set Content-Type header + localVarHttpContentType := selectHeaderContentType(localVarHttpContentTypes) + if localVarHttpContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHttpContentType + } + + // to determine the Accept header + localVarHttpHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts) + if localVarHttpHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHttpHeaderAccept + } + + r, err := a.client.prepareRequest(localVarAPIOptions, localVarPath, localVarHttpMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, err + } + + localVarHttpResponse, err := a.client.callAPI(r) + if err != nil || localVarHttpResponse == nil { + return localVarReturnValue, err + } + + localVarBody, err := ioutil.ReadAll(localVarHttpResponse.Body) + localVarHttpResponse.Body.Close() + if err != nil { + return localVarReturnValue, err + } + + // Check for common HTTP error status codes + err = CheckForHttpError(localVarHttpResponse.StatusCode, localVarBody) + if err != nil { + return localVarReturnValue, err + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHttpResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, newErr + } + + return localVarReturnValue, nil +} + +func (a *WebInputsApiService) UpdateWebInputUrl(wEBINPUTID string, updateWebInputUrlRequest UpdateWebInputUrlRequest, opts ...APIOption) (WebInputResponse, error) { + var ( + localVarAPIOptions = new(APIOptions) + localVarHttpMethod = strings.ToUpper("Put") + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue WebInputResponse + ) + + for _, opt := range opts { + opt(localVarAPIOptions) + } + + // create path and map variables + localVarPath := a.client.cfg.basePath + "/video/v1/web-inputs/{WEB_INPUT_ID}/url" + localVarPath = strings.Replace(localVarPath, "{"+"WEB_INPUT_ID"+"}", fmt.Sprintf("%v", wEBINPUTID), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + + // to determine the Content-Type header + localVarHttpContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHttpContentType := selectHeaderContentType(localVarHttpContentTypes) + if localVarHttpContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHttpContentType + } + + // to determine the Accept header + localVarHttpHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts) + if localVarHttpHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHttpHeaderAccept + } + // body params + localVarPostBody = &updateWebInputUrlRequest + + r, err := a.client.prepareRequest(localVarAPIOptions, localVarPath, localVarHttpMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, err + } + + localVarHttpResponse, err := a.client.callAPI(r) + if err != nil || localVarHttpResponse == nil { + return localVarReturnValue, err + } + + localVarBody, err := ioutil.ReadAll(localVarHttpResponse.Body) + localVarHttpResponse.Body.Close() + if err != nil { + return localVarReturnValue, err + } + + // Check for common HTTP error status codes + err = CheckForHttpError(localVarHttpResponse.StatusCode, localVarBody) + if err != nil { + return localVarReturnValue, err + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHttpResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, newErr + } + + return localVarReturnValue, nil +} diff --git a/client.go b/client.go index fe552db..e42253e 100644 --- a/client.go +++ b/client.go @@ -56,6 +56,7 @@ type APIClient struct { TranscriptionVocabulariesApi *TranscriptionVocabulariesApiService URLSigningKeysApi *URLSigningKeysApiService VideoViewsApi *VideoViewsApiService + WebInputsApi *WebInputsApiService } type service struct { @@ -91,6 +92,7 @@ func NewAPIClient(cfg *Configuration) *APIClient { c.TranscriptionVocabulariesApi = (*TranscriptionVocabulariesApiService)(&c.common) c.URLSigningKeysApi = (*URLSigningKeysApiService)(&c.common) c.VideoViewsApi = (*VideoViewsApiService)(&c.common) + c.WebInputsApi = (*WebInputsApiService)(&c.common) return c } diff --git a/configuration.go b/configuration.go index a2da6fe..9bf249c 100644 --- a/configuration.go +++ b/configuration.go @@ -22,7 +22,7 @@ type ConfigurationOption func(*Configuration) func NewConfiguration(opts ...ConfigurationOption) *Configuration { cfg := &Configuration{ basePath: "https://api.mux.com", - userAgent: "Mux Go | 5.0.2", + userAgent: "Mux Go | 5.1.0", } for _, opt := range opts { opt(cfg) diff --git a/docs/Asset.md b/docs/Asset.md index eb4fcb2..c908948 100644 --- a/docs/Asset.md +++ b/docs/Asset.md @@ -10,10 +10,10 @@ Name | Type | Description | Notes **MaxStoredResolution** | **string** | This field is deprecated. Please use `resolution_tier` instead. The maximum resolution that has been stored for the asset. The asset may be delivered at lower resolutions depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. | [optional] **ResolutionTier** | **string** | The resolution tier that the asset was ingested at, affecting billing for ingest & storage. This field also represents the highest resolution tier that the content can be delivered at, however the actual resolution may be lower depending on the device, bandwidth, and exact resolution of the uploaded asset. | [optional] **MaxResolutionTier** | **string** | Max resolution tier can be used to control the maximum `resolution_tier` your asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`. | [optional] -**EncodingTier** | **string** | The encoding tier informs the cost, quality, and available platform features for the asset. By default the `smart` encoding tier is used. [See the guide for more details.](https://docs.mux.com/guides/video/use-encoding-tiers) | [optional] +**EncodingTier** | **string** | The encoding tier informs the cost, quality, and available platform features for the asset. By default the `smart` encoding tier is used. [See the guide for more details.](https://docs.mux.com/guides/use-encoding-tiers) | [optional] **MaxStoredFrameRate** | **float64** | The maximum frame rate that has been stored for the asset. The asset may be delivered at lower frame rates depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. This field may return -1 if the frame rate of the input cannot be reliably determined. | [optional] **AspectRatio** | **string** | The aspect ratio of the asset in the form of `width:height`, for example `16:9`. | [optional] -**PlaybackIds** | [**[]PlaybackId**](PlaybackID.md) | An array of Playback ID objects. Use these to create HLS playback URLs. See [Play your videos](https://docs.mux.com/guides/video/play-your-videos) for more details. | [optional] +**PlaybackIds** | [**[]PlaybackId**](PlaybackID.md) | An array of Playback ID objects. Use these to create HLS playback URLs. See [Play your videos](https://docs.mux.com/guides/play-your-videos) for more details. | [optional] **Tracks** | [**[]Track**](Track.md) | The individual media tracks that make up an asset. | [optional] **Errors** | [**AssetErrors**](Asset_errors.md) | | [optional] **PerTitleEncode** | **bool** | | [optional] diff --git a/docs/BreakdownValue.md b/docs/BreakdownValue.md index 6de24af..6dfdcae 100644 --- a/docs/BreakdownValue.md +++ b/docs/BreakdownValue.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes **Views** | **int64** | | [optional] **Value** | **float64** | | [optional] **TotalWatchTime** | **int64** | | [optional] +**TotalPlayingTime** | **int64** | | [optional] **NegativeImpact** | **int32** | | [optional] **Field** | **string** | | [optional] diff --git a/docs/CreateAssetRequest.md b/docs/CreateAssetRequest.md index cdcc77c..6877935 100644 --- a/docs/CreateAssetRequest.md +++ b/docs/CreateAssetRequest.md @@ -7,12 +7,12 @@ Name | Type | Description | Notes **PlaybackPolicy** | [**[]PlaybackPolicy**](PlaybackPolicy.md) | An array of playback policy names that you want applied to this asset and available through `playback_ids`. Options include: `\"public\"` (anyone with the playback URL can stream the asset). And `\"signed\"` (an additional access token is required to play the asset). If no playback_policy is set, the asset will have no playback IDs and will therefore not be playable. For simplicity, a single string name can be used in place of the array in the case of only one playback policy. | [optional] **PerTitleEncode** | **bool** | | [optional] **Passthrough** | **string** | Arbitrary user-supplied metadata that will be included in the asset details and related webhooks. Can be used to store your own ID for a video along with the asset. **Max: 255 characters**. | [optional] -**Mp4Support** | **string** | Specify what level (if any) of support for mp4 playback. In most cases you should use our default HLS-based streaming playback ({playback_id}.m3u8) which can automatically adjust to viewers' connection speeds, but an mp4 can be useful for some legacy devices or downloading for offline playback. See the [Download your videos guide](/guides/video/download-your-videos) for more information. | [optional] +**Mp4Support** | **string** | Specify what level (if any) of support for mp4 playback. In most cases you should use our default HLS-based streaming playback ({playback_id}.m3u8) which can automatically adjust to viewers' connection speeds, but an mp4 can be useful for some legacy devices or downloading for offline playback. See the [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions) for more information. | [optional] **NormalizeAudio** | **bool** | Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets. | [optional] [default to false] -**MasterAccess** | **string** | Specify what level (if any) of support for master access. Master access can be enabled temporarily for your asset to be downloaded. See the [Download your videos guide](/guides/video/download-your-videos) for more information. | [optional] +**MasterAccess** | **string** | Specify what level (if any) of support for master access. Master access can be enabled temporarily for your asset to be downloaded. See the [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions) for more information. | [optional] **Test** | **bool** | Marks the asset as a test asset when the value is set to true. A Test asset can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test assets created. Test asset are watermarked with the Mux logo, limited to 10 seconds, deleted after 24 hrs. | [optional] **MaxResolutionTier** | **string** | Max resolution tier can be used to control the maximum `resolution_tier` your asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`. | [optional] -**EncodingTier** | **string** | The encoding tier informs the cost, quality, and available platform features for the asset. By default the `smart` encoding tier is used. [See the guide for more details.](https://docs.mux.com/guides/video/use-encoding-tiers) | [optional] +**EncodingTier** | **string** | The encoding tier informs the cost, quality, and available platform features for the asset. By default the `smart` encoding tier is used. [See the guide for more details.](https://docs.mux.com/guides/use-encoding-tiers) | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CreateLiveStreamRequest.md b/docs/CreateLiveStreamRequest.md index baa24bc..cbc967b 100644 --- a/docs/CreateLiveStreamRequest.md +++ b/docs/CreateLiveStreamRequest.md @@ -14,7 +14,7 @@ Name | Type | Description | Notes **GeneratedSubtitles** | [**[]LiveStreamGeneratedSubtitleSettings**](LiveStreamGeneratedSubtitleSettings.md) | Configure the incoming live stream to include subtitles created with automatic speech recognition. Each Asset created from a live stream with `generated_subtitles` configured will automatically receive two text tracks. The first of these will have a `text_source` value of `generated_live`, and will be available with `ready` status as soon as the stream is live. The second text track will have a `text_source` value of `generated_live_final` and will contain subtitles with improved accuracy, timing, and formatting. However, `generated_live_final` tracks will not be available in `ready` status until the live stream ends. If an Asset has both `generated_live` and `generated_live_final` tracks that are `ready`, then only the `generated_live_final` track will be included during playback. | [optional] **ReducedLatency** | **bool** | This field is deprecated. Please use `latency_mode` instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this if you want lower latency for your live stream. Read more here: https://mux.com/blog/reduced-latency-for-mux-live-streaming-now-available/ | [optional] **LowLatency** | **bool** | This field is deprecated. Please use `latency_mode` instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Setting this option will enable compatibility with the LL-HLS specification for low-latency streaming. This typically has lower latency than Reduced Latency streams, and cannot be combined with Reduced Latency. | [optional] -**LatencyMode** | **string** | Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags. The Low Latency value is a beta feature. Read more here: https://mux.com/blog/introducing-low-latency-live-streaming/ | [optional] +**LatencyMode** | **string** | Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags. | [optional] **Test** | **bool** | Marks the live stream as a test live stream when the value is set to true. A test live stream can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test live streams created. Test live streams are watermarked with the Mux logo and limited to 5 minutes. The test live stream is disabled after the stream is active for 5 mins and the recorded asset also deleted after 24 hours. | [optional] **SimulcastTargets** | [**[]CreateSimulcastTargetRequest**](CreateSimulcastTargetRequest.md) | | [optional] **MaxContinuousDuration** | **int32** | The time in seconds a live stream may be continuously active before being disconnected. Defaults to 12 hours. | [optional] [default to 43200] diff --git a/docs/CreateSimulcastTargetRequest.md b/docs/CreateSimulcastTargetRequest.md index 50f105b..b0c5b0c 100644 --- a/docs/CreateSimulcastTargetRequest.md +++ b/docs/CreateSimulcastTargetRequest.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Passthrough** | **string** | Arbitrary user-supplied metadata set by you when creating a simulcast target. | [optional] **StreamKey** | **string** | Stream Key represents a stream identifier on the third party live streaming service to send the parent live stream to. | [optional] -**Url** | **string** | RTMP hostname including application name for the third party live streaming service. Example: `rtmp://live.example.com/app`. | +**Url** | **string** | RTMP hostname including application name for the third party live streaming service. Example: `rtmp://live.example.com/app`. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CreateUploadRequest.md b/docs/CreateUploadRequest.md index 983c71b..29d1521 100644 --- a/docs/CreateUploadRequest.md +++ b/docs/CreateUploadRequest.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Timeout** | **int32** | Max time in seconds for the signed upload URL to be valid. If a successful upload has not occurred before the timeout limit, the direct upload is marked `timed_out` | [optional] [default to 3600] **CorsOrigin** | **string** | If the upload URL will be used in a browser, you must specify the origin in order for the signed URL to have the correct CORS headers. | [optional] -**NewAssetSettings** | [**CreateAssetRequest**](CreateAssetRequest.md) | | +**NewAssetSettings** | [**CreateAssetRequest**](CreateAssetRequest.md) | | [optional] **Test** | **bool** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CreateWebInputRequest.md b/docs/CreateWebInputRequest.md new file mode 100644 index 0000000..8e180ad --- /dev/null +++ b/docs/CreateWebInputRequest.md @@ -0,0 +1,18 @@ +# CreateWebInputRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique identifier for the Web Input. | [optional] +**CreatedAt** | **string** | Time the Web Input was created, defined as a Unix timestamp (seconds since epoch). | [optional] +**Url** | **string** | The URL for the Web Input to load. | [optional] +**AutoLaunch** | **bool** | When set to `true` the Web Input will automatically launch and start streaming immediately after creation | [optional] +**LiveStreamId** | **string** | The Live Stream ID to broadcast this Web Input to | [optional] +**Status** | **string** | | [optional] +**Passthrough** | **string** | Arbitrary metadata that will be included in the Web Input details and related webhooks. Can be used to store your own ID for the Web Input. **Max: 255 characters**. | [optional] +**Resolution** | **string** | The resolution of the viewport of the Web Input's browser instance. Defaults to 1920x1080 if not set. | [optional] [default to RESOLUTION__1920X1080] +**Timeout** | **int32** | The number of seconds that the Web Input should stream for before automatically shutting down. | [optional] [default to 3600] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Error.md b/docs/Error.md index 65cc4bd..0020237 100644 --- a/docs/Error.md +++ b/docs/Error.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **Message** | **string** | The error message. | [optional] **LastSeen** | **string** | The last time this error was seen (ISO 8601 timestamp). | [optional] **Description** | **string** | Description of the error. | [optional] -**Count** | **int64** | The total number of views that experiend this error. | [optional] +**Count** | **int64** | The total number of views that experienced this error. | [optional] **Code** | **int64** | The error code | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/GetMetricTimeseriesDataResponse.md b/docs/GetMetricTimeseriesDataResponse.md index 3d990df..a2355b8 100644 --- a/docs/GetMetricTimeseriesDataResponse.md +++ b/docs/GetMetricTimeseriesDataResponse.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes **Data** | [**[][]string**](array.md) | | [optional] **TotalRowCount** | **int64** | | [optional] **Timeframe** | **[]int64** | | [optional] +**Meta** | [**ListBreakdownValuesResponseMeta**](ListBreakdownValuesResponse_meta.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/GetMonitoringHistogramTimeseriesResponseMeta.md b/docs/GetMonitoringHistogramTimeseriesResponseMeta.md index 8a71fac..9b4f2b1 100644 --- a/docs/GetMonitoringHistogramTimeseriesResponseMeta.md +++ b/docs/GetMonitoringHistogramTimeseriesResponseMeta.md @@ -3,6 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**BucketUnit** | **string** | | [optional] **Buckets** | [**[]MonitoringHistogramTimeseriesBucket**](MonitoringHistogramTimeseriesBucket.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/GetOverallValuesResponse.md b/docs/GetOverallValuesResponse.md index 669d82d..f74521d 100644 --- a/docs/GetOverallValuesResponse.md +++ b/docs/GetOverallValuesResponse.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes **Data** | [**OverallValues**](OverallValues.md) | | [optional] **TotalRowCount** | **int64** | | [optional] **Timeframe** | **[]int64** | | [optional] +**Meta** | [**ListBreakdownValuesResponseMeta**](ListBreakdownValuesResponse_meta.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/GetRealTimeHistogramTimeseriesResponseMeta.md b/docs/GetRealTimeHistogramTimeseriesResponseMeta.md index 7a51c22..d4e0e5e 100644 --- a/docs/GetRealTimeHistogramTimeseriesResponseMeta.md +++ b/docs/GetRealTimeHistogramTimeseriesResponseMeta.md @@ -3,6 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**BucketUnit** | **string** | | [optional] **Buckets** | [**[]RealTimeHistogramTimeseriesBucket**](RealTimeHistogramTimeseriesBucket.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/IncidentResponse.md b/docs/IncidentResponse.md index f18cb4f..9769829 100644 --- a/docs/IncidentResponse.md +++ b/docs/IncidentResponse.md @@ -4,6 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Data** | [**Incident**](Incident.md) | | [optional] +**TotalRowCount** | **int64** | | [optional] **Timeframe** | **[]int64** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InputSettings.md b/docs/InputSettings.md index 420d0a6..11417c9 100644 --- a/docs/InputSettings.md +++ b/docs/InputSettings.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Url** | **string** | The URL of the file that Mux should download and use. * For the main input file, this should be the URL to the muxed file for Mux to download, for example an MP4, MOV, MKV, or TS file. Mux supports most audio/video file formats and codecs, but for fastest processing, you should [use standard inputs wherever possible](https://docs.mux.com/guides/video/minimize-processing-time). * For `audio` tracks, the URL is the location of the audio file for Mux to download, for example an M4A, WAV, or MP3 file. Mux supports most audio file formats and codecs, but for fastest processing, you should [use standard inputs wherever possible](https://docs.mux.com/guides/video/minimize-processing-time). * For `text` tracks, the URL is the location of subtitle/captions file. Mux supports [SubRip Text (SRT)](https://en.wikipedia.org/wiki/SubRip) and [Web Video Text Tracks](https://www.w3.org/TR/webvtt1/) formats for ingesting Subtitles and Closed Captions. * For Watermarking or Overlay, the URL is the location of the watermark image. * When creating clips from existing Mux assets, the URL is defined with `mux://assets/{asset_id}` template where `asset_id` is the Asset Identifier for creating the clip from. The url property may be omitted on the first input object when providing asset settings for LiveStream and Upload objects, in order to configure settings related to the primary (live stream or direct upload) input. | [optional] +**Url** | **string** | The URL of the file that Mux should download and use. * For the main input file, this should be the URL to the muxed file for Mux to download, for example an MP4, MOV, MKV, or TS file. Mux supports most audio/video file formats and codecs, but for fastest processing, you should [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time). * For `audio` tracks, the URL is the location of the audio file for Mux to download, for example an M4A, WAV, or MP3 file. Mux supports most audio file formats and codecs, but for fastest processing, you should [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time). * For `text` tracks, the URL is the location of subtitle/captions file. Mux supports [SubRip Text (SRT)](https://en.wikipedia.org/wiki/SubRip) and [Web Video Text Tracks](https://www.w3.org/TR/webvtt1/) formats for ingesting Subtitles and Closed Captions. * For Watermarking or Overlay, the URL is the location of the watermark image. * When creating clips from existing Mux assets, the URL is defined with `mux://assets/{asset_id}` template where `asset_id` is the Asset Identifier for creating the clip from. The url property may be omitted on the first input object when providing asset settings for LiveStream and Upload objects, in order to configure settings related to the primary (live stream or direct upload) input. | [optional] **OverlaySettings** | [**InputSettingsOverlaySettings**](InputSettings_overlay_settings.md) | | [optional] **GeneratedSubtitles** | [**[]AssetGeneratedSubtitleSettings**](AssetGeneratedSubtitleSettings.md) | Generate subtitle tracks using automatic speech recognition using this configuration. This may only be provided for the first input object (the main input file). For direct uploads, this first input should omit the url parameter, as the main input file is provided via the direct upload. This will create subtitles based on the audio track ingested from that main input file. Note that subtitle generation happens after initial ingest, so the generated tracks will be in the `preparing` state when the asset transitions to `ready`. | [optional] **StartTime** | **float64** | The time offset in seconds from the beginning of the video indicating the clip's starting marker. The default value is 0 when not included. This parameter is only applicable for creating clips when `input.url` has `mux://assets/{asset_id}` format. | [optional] diff --git a/docs/Insight.md b/docs/Insight.md index 6d7aad7..0877f55 100644 --- a/docs/Insight.md +++ b/docs/Insight.md @@ -4,6 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **TotalWatchTime** | **int64** | | [optional] +**TotalPlayingTime** | **int64** | | [optional] **TotalViews** | **int64** | | [optional] **NegativeImpactScore** | **float32** | | [optional] **Metric** | **float64** | | [optional] diff --git a/docs/LaunchWebInputResponse.md b/docs/LaunchWebInputResponse.md new file mode 100644 index 0000000..c6f9f32 --- /dev/null +++ b/docs/LaunchWebInputResponse.md @@ -0,0 +1,10 @@ +# LaunchWebInputResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Data** | [**map[string]interface{}**](.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ListBreakdownValuesResponse.md b/docs/ListBreakdownValuesResponse.md index e9e3d23..a8f62e6 100644 --- a/docs/ListBreakdownValuesResponse.md +++ b/docs/ListBreakdownValuesResponse.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes **Data** | [**[]BreakdownValue**](BreakdownValue.md) | | [optional] **TotalRowCount** | **int64** | | [optional] **Timeframe** | **[]int64** | | [optional] +**Meta** | [**ListBreakdownValuesResponseMeta**](ListBreakdownValuesResponse_meta.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ListBreakdownValuesResponseMeta.md b/docs/ListBreakdownValuesResponseMeta.md new file mode 100644 index 0000000..e415637 --- /dev/null +++ b/docs/ListBreakdownValuesResponseMeta.md @@ -0,0 +1,11 @@ +# ListBreakdownValuesResponseMeta + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Granularity** | **string** | | [optional] +**Aggregation** | **string** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ListInsightsResponse.md b/docs/ListInsightsResponse.md index de60301..eea6577 100644 --- a/docs/ListInsightsResponse.md +++ b/docs/ListInsightsResponse.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes **Data** | [**[]Insight**](Insight.md) | | [optional] **TotalRowCount** | **int64** | | [optional] **Timeframe** | **[]int64** | | [optional] +**Meta** | [**ListBreakdownValuesResponseMeta**](ListBreakdownValuesResponse_meta.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ListWebInputsResponse.md b/docs/ListWebInputsResponse.md new file mode 100644 index 0000000..b85bbe4 --- /dev/null +++ b/docs/ListWebInputsResponse.md @@ -0,0 +1,10 @@ +# ListWebInputsResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Data** | [**[]WebInput**](WebInput.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/LiveStream.md b/docs/LiveStream.md index 4195717..7a25d32 100644 --- a/docs/LiveStream.md +++ b/docs/LiveStream.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **ActiveAssetId** | **string** | The Asset that is currently being created if there is an active broadcast. | [optional] **RecentAssetIds** | **[]string** | An array of strings with the most recent Asset IDs that were created from this Live Stream. The most recently generated Asset ID is the last entry in the list. | [optional] **Status** | [**LiveStreamStatus**](LiveStreamStatus.md) | | [optional] -**PlaybackIds** | [**[]PlaybackId**](PlaybackID.md) | An array of Playback ID objects. Use these to create HLS playback URLs. See [Play your videos](https://docs.mux.com/guides/video/play-your-videos) for more details. | [optional] +**PlaybackIds** | [**[]PlaybackId**](PlaybackID.md) | An array of Playback ID objects. Use these to create HLS playback URLs. See [Play your videos](https://docs.mux.com/guides/play-your-videos) for more details. | [optional] **NewAssetSettings** | [**CreateAssetRequest**](CreateAssetRequest.md) | | [optional] **Passthrough** | **string** | Arbitrary user-supplied metadata set for the asset. Max 255 characters. | [optional] **AudioOnly** | **bool** | The live stream only processes the audio track if the value is set to true. Mux drops the video track if broadcasted. | [optional] @@ -18,10 +18,10 @@ Name | Type | Description | Notes **ReconnectWindow** | **float32** | When live streaming software disconnects from Mux, either intentionally or due to a drop in the network, the Reconnect Window is the time in seconds that Mux should wait for the streaming software to reconnect before considering the live stream finished and completing the recorded asset. **Max**: 1800s (30 minutes). If not specified directly, Standard Latency streams have a Reconnect Window of 60 seconds; Reduced and Low Latency streams have a default of 0 seconds, or no Reconnect Window. For that reason, we suggest specifying a value other than zero for Reduced and Low Latency streams. Reduced and Low Latency streams with a Reconnect Window greater than zero will insert slate media into the recorded asset while waiting for the streaming software to reconnect or when there are brief interruptions in the live stream media. When using a Reconnect Window setting higher than 60 seconds with a Standard Latency stream, we highly recommend enabling slate with the `use_slate_for_standard_latency` option. | [optional] [default to 60] **UseSlateForStandardLatency** | **bool** | By default, Standard Latency live streams do not have slate media inserted while waiting for live streaming software to reconnect to Mux. Setting this to true enables slate insertion on a Standard Latency stream. | [optional] [default to false] **ReconnectSlateUrl** | **string** | The URL of the image file that Mux should download and use as slate media during interruptions of the live stream media. This file will be downloaded each time a new recorded asset is created from the live stream. If this is not set, the default slate media will be used. | [optional] -**ReducedLatency** | **bool** | This field is deprecated. Please use `latency_mode` instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this if you want lower latency for your live stream. See the [Reduce live stream latency guide](https://docs.mux.com/guides/video/reduce-live-stream-latency) to understand the tradeoffs. | [optional] +**ReducedLatency** | **bool** | This field is deprecated. Please use `latency_mode` instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this if you want lower latency for your live stream. See the [Reduce live stream latency guide](https://docs.mux.com/guides/reduce-live-stream-latency) to understand the tradeoffs. | [optional] **LowLatency** | **bool** | This field is deprecated. Please use `latency_mode` instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Setting this option will enable compatibility with the LL-HLS specification for low-latency streaming. This typically has lower latency than Reduced Latency streams, and cannot be combined with Reduced Latency. | [optional] -**SimulcastTargets** | [**[]SimulcastTarget**](SimulcastTarget.md) | Each Simulcast Target contains configuration details to broadcast (or \"restream\") a live stream to a third-party streaming service. [See the Stream live to 3rd party platforms guide](https://docs.mux.com/guides/video/stream-live-to-3rd-party-platforms). | [optional] -**LatencyMode** | **string** | Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags. The Low Latency value is a beta feature. Read more here: https://mux.com/blog/introducing-low-latency-live-streaming/ | [optional] +**SimulcastTargets** | [**[]SimulcastTarget**](SimulcastTarget.md) | Each Simulcast Target contains configuration details to broadcast (or \"restream\") a live stream to a third-party streaming service. [See the Stream live to 3rd party platforms guide](https://docs.mux.com/guides/stream-live-to-3rd-party-platforms). | [optional] +**LatencyMode** | **string** | Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags. | [optional] **Test** | **bool** | True means this live stream is a test live stream. Test live streams can be used to help evaluate the Mux Video APIs for free. There is no limit on the number of test live streams, but they are watermarked with the Mux logo, and limited to 5 minutes. The test live stream is disabled after the stream is active for 5 mins and the recorded asset also deleted after 24 hours. | [optional] **MaxContinuousDuration** | **int32** | The time in seconds a live stream may be continuously active before being disconnected. Defaults to 12 hours. | [optional] [default to 43200] diff --git a/docs/MonitoringBreakdownValue.md b/docs/MonitoringBreakdownValue.md index fb29c33..b7da0db 100644 --- a/docs/MonitoringBreakdownValue.md +++ b/docs/MonitoringBreakdownValue.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes **MetricValue** | **float64** | | [optional] **DisplayValue** | **string** | | [optional] **ConcurrentViewers** | **int64** | | [optional] +**StartingUpViewers** | **int64** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/OverallValues.md b/docs/OverallValues.md index 4c31c66..5de6234 100644 --- a/docs/OverallValues.md +++ b/docs/OverallValues.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes **Value** | **float64** | | [optional] **TotalWatchTime** | **int64** | | [optional] **TotalViews** | **int64** | | [optional] +**TotalPlayingTime** | **int64** | | [optional] **GlobalValue** | **float64** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RealTimeBreakdownValue.md b/docs/RealTimeBreakdownValue.md index d6fbef7..432e363 100644 --- a/docs/RealTimeBreakdownValue.md +++ b/docs/RealTimeBreakdownValue.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes **MetricValue** | **float64** | | [optional] **DisplayValue** | **string** | | [optional] **ConcurrentViewers** | **int64** | | [optional] +**StartingUpViewers** | **int64** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ReloadWebInputResponse.md b/docs/ReloadWebInputResponse.md new file mode 100644 index 0000000..b6bea9b --- /dev/null +++ b/docs/ReloadWebInputResponse.md @@ -0,0 +1,10 @@ +# ReloadWebInputResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Data** | [**map[string]interface{}**](.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Score.md b/docs/Score.md index ad600d3..84678a5 100644 --- a/docs/Score.md +++ b/docs/Score.md @@ -5,8 +5,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **WatchTime** | **int64** | | [optional] **ViewCount** | **int64** | | [optional] +**UniqueViewers** | **int64** | | [optional] +**StartedViews** | **int64** | | [optional] +**TotalPlayingTime** | **int64** | | [optional] **Name** | **string** | | [optional] +**EndedViews** | **int64** | | [optional] **Value** | **float64** | | [optional] +**Type** | **string** | | [optional] **Metric** | **string** | | [optional] **Items** | [**[]Metric**](Metric.md) | | [optional] diff --git a/docs/ShutdownWebInputResponse.md b/docs/ShutdownWebInputResponse.md new file mode 100644 index 0000000..dae2a16 --- /dev/null +++ b/docs/ShutdownWebInputResponse.md @@ -0,0 +1,10 @@ +# ShutdownWebInputResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Data** | [**map[string]interface{}**](.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/SpacesApi.md b/docs/SpacesApi.md index 81211c0..5c97e2d 100644 --- a/docs/SpacesApi.md +++ b/docs/SpacesApi.md @@ -190,7 +190,7 @@ Name | Type | Description | Notes > ListSpacesResponse ListSpaces(ctx, optional) List spaces -List all spaces in the current enviroment. +List all spaces in the current environment. ### Required Parameters diff --git a/docs/UpdateLiveStreamRequest.md b/docs/UpdateLiveStreamRequest.md index 9b1065a..2ba7410 100644 --- a/docs/UpdateLiveStreamRequest.md +++ b/docs/UpdateLiveStreamRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Passthrough** | **string** | Arbitrary user-supplied metadata set for the live stream. Max 255 characters. In order to clear this value, the field should be included with an empty-string value. | [optional] -**LatencyMode** | **string** | Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags. The Low Latency value is a beta feature. Read more here: https://mux.com/blog/introducing-low-latency-live-streaming/ | [optional] +**LatencyMode** | **string** | Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags. | [optional] **ReconnectWindow** | **float32** | When live streaming software disconnects from Mux, either intentionally or due to a drop in the network, the Reconnect Window is the time in seconds that Mux should wait for the streaming software to reconnect before considering the live stream finished and completing the recorded asset. If not specified directly, Standard Latency streams have a Reconnect Window of 60 seconds; Reduced and Low Latency streams have a default of 0 seconds, or no Reconnect Window. For that reason, we suggest specifying a value other than zero for Reduced and Low Latency streams. Reduced and Low Latency streams with a Reconnect Window greater than zero will insert slate media into the recorded asset while waiting for the streaming software to reconnect or when there are brief interruptions in the live stream media. When using a Reconnect Window setting higher than 60 seconds with a Standard Latency stream, we highly recommend enabling slate with the `use_slate_for_standard_latency` option. | [optional] [default to 60] **UseSlateForStandardLatency** | **bool** | By default, Standard Latency live streams do not have slate media inserted while waiting for live streaming software to reconnect to Mux. Setting this to true enables slate insertion on a Standard Latency stream. | [optional] [default to false] **ReconnectSlateUrl** | **string** | The URL of the image file that Mux should download and use as slate media during interruptions of the live stream media. This file will be downloaded each time a new recorded asset is created from the live stream. Set this to a blank string to clear the value so that the default slate media will be used. | [optional] diff --git a/docs/UpdateWebInputUrlRequest.md b/docs/UpdateWebInputUrlRequest.md new file mode 100644 index 0000000..5a1ad97 --- /dev/null +++ b/docs/UpdateWebInputUrlRequest.md @@ -0,0 +1,10 @@ +# UpdateWebInputUrlRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Url** | **string** | The URL for the Web Input to load. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VideoView.md b/docs/VideoView.md index 3309e71..c30ab91 100644 --- a/docs/VideoView.md +++ b/docs/VideoView.md @@ -144,6 +144,8 @@ Name | Type | Description | Notes **ViewDroppedFrameCount** | **int64** | | [optional] **ViewHasAd** | **bool** | | [optional] **VideoStartupFailure** | **bool** | | [optional] +**LongResume** | **bool** | | [optional] +**LongRebuffering** | **bool** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/VideoViewEvent.md b/docs/VideoViewEvent.md index e329ece..6ea8336 100644 --- a/docs/VideoViewEvent.md +++ b/docs/VideoViewEvent.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **PlaybackTime** | **int64** | | [optional] **Name** | **string** | | [optional] **EventTime** | **int64** | | [optional] +**Details** | [**map[string]map[string]interface{}**](map[string]interface{}.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/VideoViewResponse.md b/docs/VideoViewResponse.md index de69db0..8025089 100644 --- a/docs/VideoViewResponse.md +++ b/docs/VideoViewResponse.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Data** | [**VideoView**](VideoView.md) | | [optional] **Timeframe** | **[]int64** | | [optional] +**TotalRowCount** | **int64** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/WebInput.md b/docs/WebInput.md new file mode 100644 index 0000000..4990b92 --- /dev/null +++ b/docs/WebInput.md @@ -0,0 +1,18 @@ +# WebInput + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique identifier for the Web Input. | [optional] +**CreatedAt** | **string** | Time the Web Input was created, defined as a Unix timestamp (seconds since epoch). | [optional] +**Url** | **string** | The URL for the Web Input to load. | [optional] +**AutoLaunch** | **bool** | When set to `true` the Web Input will automatically launch and start streaming immediately after creation | [optional] +**LiveStreamId** | **string** | The Live Stream ID to broadcast this Web Input to | [optional] +**Status** | **string** | | [optional] +**Passthrough** | **string** | Arbitrary metadata that will be included in the Web Input details and related webhooks. Can be used to store your own ID for the Web Input. **Max: 255 characters**. | [optional] +**Resolution** | **string** | The resolution of the viewport of the Web Input's browser instance. Defaults to 1920x1080 if not set. | [optional] [default to RESOLUTION__1920X1080] +**Timeout** | **int32** | The number of seconds that the Web Input should stream for before automatically shutting down. | [optional] [default to 3600] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/WebInputResponse.md b/docs/WebInputResponse.md new file mode 100644 index 0000000..3fc3ba5 --- /dev/null +++ b/docs/WebInputResponse.md @@ -0,0 +1,10 @@ +# WebInputResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Data** | [**WebInput**](WebInput.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/WebInputsApi.md b/docs/WebInputsApi.md new file mode 100644 index 0000000..de197ab --- /dev/null +++ b/docs/WebInputsApi.md @@ -0,0 +1,249 @@ +# \WebInputsApi + +All URIs are relative to *https://api.mux.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CreateWebInput**](WebInputsApi.md#CreateWebInput) | **Post** /video/v1/web-inputs | Create a new Web Input +[**DeleteWebInput**](WebInputsApi.md#DeleteWebInput) | **Delete** /video/v1/web-inputs/{WEB_INPUT_ID} | Delete a Web Input +[**GetWebInput**](WebInputsApi.md#GetWebInput) | **Get** /video/v1/web-inputs/{WEB_INPUT_ID} | Retrieve a Web Input +[**LaunchWebInput**](WebInputsApi.md#LaunchWebInput) | **Put** /video/v1/web-inputs/{WEB_INPUT_ID}/launch | Launch a Web Input +[**ListWebInputs**](WebInputsApi.md#ListWebInputs) | **Get** /video/v1/web-inputs | List Web Inputs +[**ReloadWebInput**](WebInputsApi.md#ReloadWebInput) | **Put** /video/v1/web-inputs/{WEB_INPUT_ID}/reload | Reload a Web Input +[**ShutdownWebInput**](WebInputsApi.md#ShutdownWebInput) | **Put** /video/v1/web-inputs/{WEB_INPUT_ID}/shutdown | Shut down a Web Input +[**UpdateWebInputUrl**](WebInputsApi.md#UpdateWebInputUrl) | **Put** /video/v1/web-inputs/{WEB_INPUT_ID}/url | Update Web Input URL + + +# **CreateWebInput** +> WebInputResponse CreateWebInput(ctx, createWebInputRequest) +Create a new Web Input + +Create a new Web Input + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. + **createWebInputRequest** | [**CreateWebInputRequest**](CreateWebInputRequest.md)| | + +### Return type + +[**WebInputResponse**](WebInputResponse.md) + +### Authorization + +[accessToken](../README.md#accessToken) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **DeleteWebInput** +> DeleteWebInput(ctx, wEBINPUTID) +Delete a Web Input + +Deletes a Web Input and all its data + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. + **wEBINPUTID** | **string**| The Web Input ID | + +### Return type + + (empty response body) + +### Authorization + +[accessToken](../README.md#accessToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **GetWebInput** +> WebInputResponse GetWebInput(ctx, wEBINPUTID) +Retrieve a Web Input + +Retrieve a single Web Input's info + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. + **wEBINPUTID** | **string**| The Web Input ID | + +### Return type + +[**WebInputResponse**](WebInputResponse.md) + +### Authorization + +[accessToken](../README.md#accessToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **LaunchWebInput** +> LaunchWebInputResponse LaunchWebInput(ctx, wEBINPUTID) +Launch a Web Input + +Launches the browsers instance, loads the URL specified, and then starts streaming to the specified Live Stream. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. + **wEBINPUTID** | **string**| The Web Input ID | + +### Return type + +[**LaunchWebInputResponse**](LaunchWebInputResponse.md) + +### Authorization + +[accessToken](../README.md#accessToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **ListWebInputs** +> ListWebInputsResponse ListWebInputs(ctx, optional) +List Web Inputs + +List Web Inputs + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. + **optional** | ***ListWebInputsOpts** | optional parameters | nil if no parameters + +### Optional Parameters +Optional parameters are passed through a pointer to a ListWebInputsOpts struct + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **limit** | **optional.Int32**| Number of items to include in the response | [default to 25] + **page** | **optional.Int32**| Offset by this many pages, of the size of `limit` | [default to 1] + +### Return type + +[**ListWebInputsResponse**](ListWebInputsResponse.md) + +### Authorization + +[accessToken](../README.md#accessToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **ReloadWebInput** +> ReloadWebInputResponse ReloadWebInput(ctx, wEBINPUTID) +Reload a Web Input + +Reloads the page that a Web Input is displaying. Note: Using this when the Web Input is streaming will display the page reloading. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. + **wEBINPUTID** | **string**| The Web Input ID | + +### Return type + +[**ReloadWebInputResponse**](ReloadWebInputResponse.md) + +### Authorization + +[accessToken](../README.md#accessToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **ShutdownWebInput** +> ShutdownWebInputResponse ShutdownWebInput(ctx, wEBINPUTID) +Shut down a Web Input + +Ends streaming to the specified Live Stream, and then shuts down the Web Input browser instance. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. + **wEBINPUTID** | **string**| The Web Input ID | + +### Return type + +[**ShutdownWebInputResponse**](ShutdownWebInputResponse.md) + +### Authorization + +[accessToken](../README.md#accessToken) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **UpdateWebInputUrl** +> WebInputResponse UpdateWebInputUrl(ctx, wEBINPUTID, updateWebInputUrlRequest) +Update Web Input URL + +Changes the URL that a Web Input loads when it launches. Note: This can only be called when the Web Input is idle. + +### Required Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. + **wEBINPUTID** | **string**| The Web Input ID | + **updateWebInputUrlRequest** | [**UpdateWebInputUrlRequest**](UpdateWebInputUrlRequest.md)| | + +### Return type + +[**WebInputResponse**](WebInputResponse.md) + +### Authorization + +[accessToken](../README.md#accessToken) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/model_asset.go b/model_asset.go index c0a0fee..fc5f661 100644 --- a/model_asset.go +++ b/model_asset.go @@ -18,13 +18,13 @@ type Asset struct { ResolutionTier string `json:"resolution_tier,omitempty"` // Max resolution tier can be used to control the maximum `resolution_tier` your asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`. MaxResolutionTier string `json:"max_resolution_tier,omitempty"` - // The encoding tier informs the cost, quality, and available platform features for the asset. By default the `smart` encoding tier is used. [See the guide for more details.](https://docs.mux.com/guides/video/use-encoding-tiers) + // The encoding tier informs the cost, quality, and available platform features for the asset. By default the `smart` encoding tier is used. [See the guide for more details.](https://docs.mux.com/guides/use-encoding-tiers) EncodingTier string `json:"encoding_tier,omitempty"` // The maximum frame rate that has been stored for the asset. The asset may be delivered at lower frame rates depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. This field may return -1 if the frame rate of the input cannot be reliably determined. MaxStoredFrameRate float64 `json:"max_stored_frame_rate,omitempty"` // The aspect ratio of the asset in the form of `width:height`, for example `16:9`. AspectRatio string `json:"aspect_ratio,omitempty"` - // An array of Playback ID objects. Use these to create HLS playback URLs. See [Play your videos](https://docs.mux.com/guides/video/play-your-videos) for more details. + // An array of Playback ID objects. Use these to create HLS playback URLs. See [Play your videos](https://docs.mux.com/guides/play-your-videos) for more details. PlaybackIds []PlaybackId `json:"playback_ids,omitempty"` // The individual media tracks that make up an asset. Tracks []Track `json:"tracks,omitempty"` diff --git a/model_asset_non_standard_input_reasons.go b/model_asset_non_standard_input_reasons.go index 21d9733..8eb1d17 100644 --- a/model_asset_non_standard_input_reasons.go +++ b/model_asset_non_standard_input_reasons.go @@ -3,7 +3,7 @@ package muxgo -// An object containing one or more reasons the input file is non-standard. See [the guide on minimizing processing time](https://docs.mux.com/guides/video/minimize-processing-time) for more information on what a standard input is defined as. This object only exists on on-demand assets that have non-standard inputs, so if missing you can assume the input qualifies as standard. +// An object containing one or more reasons the input file is non-standard. See [the guide on minimizing processing time](https://docs.mux.com/guides/minimize-processing-time) for more information on what a standard input is defined as. This object only exists on on-demand assets that have non-standard inputs, so if missing you can assume the input qualifies as standard. type AssetNonStandardInputReasons struct { // The video codec used on the input file. For example, the input file encoded with `hevc` video codec is non-standard and the value of this parameter is `hevc`. VideoCodec string `json:"video_codec,omitempty"` diff --git a/model_asset_static_renditions.go b/model_asset_static_renditions.go index 741e1b6..e9105b3 100644 --- a/model_asset_static_renditions.go +++ b/model_asset_static_renditions.go @@ -3,7 +3,7 @@ package muxgo -// An object containing the current status of any static renditions (mp4s). The object does not exist if no static renditions have been requested. See [Download your videos](https://docs.mux.com/guides/video/download-your-videos) for more information. +// An object containing the current status of any static renditions (mp4s). The object does not exist if no static renditions have been requested. See [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions) for more information. type AssetStaticRenditions struct { // Indicates the status of downloadable MP4 versions of this asset. Status string `json:"status,omitempty"` diff --git a/model_breakdown_value.go b/model_breakdown_value.go index 3abecec..9471d68 100644 --- a/model_breakdown_value.go +++ b/model_breakdown_value.go @@ -4,9 +4,10 @@ package muxgo type BreakdownValue struct { - Views int64 `json:"views,omitempty"` - Value float64 `json:"value,omitempty"` - TotalWatchTime int64 `json:"total_watch_time,omitempty"` - NegativeImpact int32 `json:"negative_impact,omitempty"` - Field string `json:"field,omitempty"` + Views int64 `json:"views,omitempty"` + Value float64 `json:"value,omitempty"` + TotalWatchTime int64 `json:"total_watch_time,omitempty"` + TotalPlayingTime int64 `json:"total_playing_time,omitempty"` + NegativeImpact int32 `json:"negative_impact,omitempty"` + Field string `json:"field,omitempty"` } diff --git a/model_create_asset_request.go b/model_create_asset_request.go index 1889bb0..9b7f953 100644 --- a/model_create_asset_request.go +++ b/model_create_asset_request.go @@ -11,16 +11,16 @@ type CreateAssetRequest struct { PerTitleEncode bool `json:"per_title_encode,omitempty"` // Arbitrary user-supplied metadata that will be included in the asset details and related webhooks. Can be used to store your own ID for a video along with the asset. **Max: 255 characters**. Passthrough string `json:"passthrough,omitempty"` - // Specify what level (if any) of support for mp4 playback. In most cases you should use our default HLS-based streaming playback ({playback_id}.m3u8) which can automatically adjust to viewers' connection speeds, but an mp4 can be useful for some legacy devices or downloading for offline playback. See the [Download your videos guide](/guides/video/download-your-videos) for more information. + // Specify what level (if any) of support for mp4 playback. In most cases you should use our default HLS-based streaming playback ({playback_id}.m3u8) which can automatically adjust to viewers' connection speeds, but an mp4 can be useful for some legacy devices or downloading for offline playback. See the [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions) for more information. Mp4Support string `json:"mp4_support,omitempty"` // Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets. NormalizeAudio bool `json:"normalize_audio,omitempty"` - // Specify what level (if any) of support for master access. Master access can be enabled temporarily for your asset to be downloaded. See the [Download your videos guide](/guides/video/download-your-videos) for more information. + // Specify what level (if any) of support for master access. Master access can be enabled temporarily for your asset to be downloaded. See the [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions) for more information. MasterAccess string `json:"master_access,omitempty"` // Marks the asset as a test asset when the value is set to true. A Test asset can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test assets created. Test asset are watermarked with the Mux logo, limited to 10 seconds, deleted after 24 hrs. Test bool `json:"test,omitempty"` // Max resolution tier can be used to control the maximum `resolution_tier` your asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`. MaxResolutionTier string `json:"max_resolution_tier,omitempty"` - // The encoding tier informs the cost, quality, and available platform features for the asset. By default the `smart` encoding tier is used. [See the guide for more details.](https://docs.mux.com/guides/video/use-encoding-tiers) + // The encoding tier informs the cost, quality, and available platform features for the asset. By default the `smart` encoding tier is used. [See the guide for more details.](https://docs.mux.com/guides/use-encoding-tiers) EncodingTier string `json:"encoding_tier,omitempty"` } diff --git a/model_create_live_stream_request.go b/model_create_live_stream_request.go index 783467a..44f9dff 100644 --- a/model_create_live_stream_request.go +++ b/model_create_live_stream_request.go @@ -23,7 +23,7 @@ type CreateLiveStreamRequest struct { ReducedLatency bool `json:"reduced_latency,omitempty"` // This field is deprecated. Please use `latency_mode` instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Setting this option will enable compatibility with the LL-HLS specification for low-latency streaming. This typically has lower latency than Reduced Latency streams, and cannot be combined with Reduced Latency. LowLatency bool `json:"low_latency,omitempty"` - // Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags. The Low Latency value is a beta feature. Read more here: https://mux.com/blog/introducing-low-latency-live-streaming/ + // Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags. LatencyMode string `json:"latency_mode,omitempty"` // Marks the live stream as a test live stream when the value is set to true. A test live stream can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test live streams created. Test live streams are watermarked with the Mux logo and limited to 5 minutes. The test live stream is disabled after the stream is active for 5 mins and the recorded asset also deleted after 24 hours. Test bool `json:"test,omitempty"` diff --git a/model_create_simulcast_target_request.go b/model_create_simulcast_target_request.go index 5c07d60..74e55c9 100644 --- a/model_create_simulcast_target_request.go +++ b/model_create_simulcast_target_request.go @@ -9,5 +9,5 @@ type CreateSimulcastTargetRequest struct { // Stream Key represents a stream identifier on the third party live streaming service to send the parent live stream to. StreamKey string `json:"stream_key,omitempty"` // RTMP hostname including application name for the third party live streaming service. Example: `rtmp://live.example.com/app`. - Url string `json:"url"` + Url string `json:"url,omitempty"` } diff --git a/model_create_upload_request.go b/model_create_upload_request.go index 4a8b114..d2a9e5a 100644 --- a/model_create_upload_request.go +++ b/model_create_upload_request.go @@ -8,6 +8,6 @@ type CreateUploadRequest struct { Timeout int32 `json:"timeout,omitempty"` // If the upload URL will be used in a browser, you must specify the origin in order for the signed URL to have the correct CORS headers. CorsOrigin string `json:"cors_origin,omitempty"` - NewAssetSettings CreateAssetRequest `json:"new_asset_settings"` + NewAssetSettings CreateAssetRequest `json:"new_asset_settings,omitempty"` Test bool `json:"test,omitempty"` } diff --git a/model_create_web_input_request.go b/model_create_web_input_request.go new file mode 100644 index 0000000..1ba4ded --- /dev/null +++ b/model_create_web_input_request.go @@ -0,0 +1,24 @@ +// Mux Go - Copyright 2019 Mux Inc. +// NOTE: This file is auto generated. Do not edit this file manually. + +package muxgo + +type CreateWebInputRequest struct { + // Unique identifier for the Web Input. + Id string `json:"id,omitempty"` + // Time the Web Input was created, defined as a Unix timestamp (seconds since epoch). + CreatedAt string `json:"created_at,omitempty"` + // The URL for the Web Input to load. + Url string `json:"url,omitempty"` + // When set to `true` the Web Input will automatically launch and start streaming immediately after creation + AutoLaunch bool `json:"auto_launch,omitempty"` + // The Live Stream ID to broadcast this Web Input to + LiveStreamId string `json:"live_stream_id,omitempty"` + Status string `json:"status,omitempty"` + // Arbitrary metadata that will be included in the Web Input details and related webhooks. Can be used to store your own ID for the Web Input. **Max: 255 characters**. + Passthrough string `json:"passthrough,omitempty"` + // The resolution of the viewport of the Web Input's browser instance. Defaults to 1920x1080 if not set. + Resolution string `json:"resolution,omitempty"` + // The number of seconds that the Web Input should stream for before automatically shutting down. + Timeout int32 `json:"timeout,omitempty"` +} diff --git a/model_error.go b/model_error.go index e3a6e42..cf6f51d 100644 --- a/model_error.go +++ b/model_error.go @@ -16,7 +16,7 @@ type Error struct { LastSeen string `json:"last_seen,omitempty"` // Description of the error. Description string `json:"description,omitempty"` - // The total number of views that experiend this error. + // The total number of views that experienced this error. Count int64 `json:"count,omitempty"` // The error code Code int64 `json:"code,omitempty"` diff --git a/model_get_metric_timeseries_data_response.go b/model_get_metric_timeseries_data_response.go index 8c108bc..f174a6c 100644 --- a/model_get_metric_timeseries_data_response.go +++ b/model_get_metric_timeseries_data_response.go @@ -9,9 +9,10 @@ import ( ) type GetMetricTimeseriesDataResponse struct { - Data [][]string `json:"data,omitempty"` - TotalRowCount int64 `json:"total_row_count,omitempty"` - Timeframe []int64 `json:"timeframe,omitempty"` + Data [][]string `json:"data,omitempty"` + TotalRowCount int64 `json:"total_row_count,omitempty"` + Timeframe []int64 `json:"timeframe,omitempty"` + Meta ListBreakdownValuesResponseMeta `json:"meta,omitempty"` } // !!! 🐉 Here be dragons 🐉 !!! diff --git a/model_get_monitoring_histogram_timeseries_response_meta.go b/model_get_monitoring_histogram_timeseries_response_meta.go index c029172..4c19d85 100644 --- a/model_get_monitoring_histogram_timeseries_response_meta.go +++ b/model_get_monitoring_histogram_timeseries_response_meta.go @@ -4,5 +4,6 @@ package muxgo type GetMonitoringHistogramTimeseriesResponseMeta struct { - Buckets []MonitoringHistogramTimeseriesBucket `json:"buckets,omitempty"` + BucketUnit string `json:"bucket_unit,omitempty"` + Buckets []MonitoringHistogramTimeseriesBucket `json:"buckets,omitempty"` } diff --git a/model_get_overall_values_response.go b/model_get_overall_values_response.go index 55cc5af..57d3fae 100644 --- a/model_get_overall_values_response.go +++ b/model_get_overall_values_response.go @@ -4,7 +4,8 @@ package muxgo type GetOverallValuesResponse struct { - Data OverallValues `json:"data,omitempty"` - TotalRowCount int64 `json:"total_row_count,omitempty"` - Timeframe []int64 `json:"timeframe,omitempty"` + Data OverallValues `json:"data,omitempty"` + TotalRowCount int64 `json:"total_row_count,omitempty"` + Timeframe []int64 `json:"timeframe,omitempty"` + Meta ListBreakdownValuesResponseMeta `json:"meta,omitempty"` } diff --git a/model_get_real_time_histogram_timeseries_response_meta.go b/model_get_real_time_histogram_timeseries_response_meta.go index f12c3ec..5ae643f 100644 --- a/model_get_real_time_histogram_timeseries_response_meta.go +++ b/model_get_real_time_histogram_timeseries_response_meta.go @@ -4,5 +4,6 @@ package muxgo type GetRealTimeHistogramTimeseriesResponseMeta struct { - Buckets []RealTimeHistogramTimeseriesBucket `json:"buckets,omitempty"` + BucketUnit string `json:"bucket_unit,omitempty"` + Buckets []RealTimeHistogramTimeseriesBucket `json:"buckets,omitempty"` } diff --git a/model_incident_response.go b/model_incident_response.go index 64c4670..58efcef 100644 --- a/model_incident_response.go +++ b/model_incident_response.go @@ -4,6 +4,7 @@ package muxgo type IncidentResponse struct { - Data Incident `json:"data,omitempty"` - Timeframe []int64 `json:"timeframe,omitempty"` + Data Incident `json:"data,omitempty"` + TotalRowCount int64 `json:"total_row_count,omitempty"` + Timeframe []int64 `json:"timeframe,omitempty"` } diff --git a/model_input_settings.go b/model_input_settings.go index 947fe18..50f9b2c 100644 --- a/model_input_settings.go +++ b/model_input_settings.go @@ -5,7 +5,7 @@ package muxgo // An array of objects that each describe an input file to be used to create the asset. As a shortcut, `input` can also be a string URL for a file when only one input file is used. See `input[].url` for requirements. type InputSettings struct { - // The URL of the file that Mux should download and use. * For the main input file, this should be the URL to the muxed file for Mux to download, for example an MP4, MOV, MKV, or TS file. Mux supports most audio/video file formats and codecs, but for fastest processing, you should [use standard inputs wherever possible](https://docs.mux.com/guides/video/minimize-processing-time). * For `audio` tracks, the URL is the location of the audio file for Mux to download, for example an M4A, WAV, or MP3 file. Mux supports most audio file formats and codecs, but for fastest processing, you should [use standard inputs wherever possible](https://docs.mux.com/guides/video/minimize-processing-time). * For `text` tracks, the URL is the location of subtitle/captions file. Mux supports [SubRip Text (SRT)](https://en.wikipedia.org/wiki/SubRip) and [Web Video Text Tracks](https://www.w3.org/TR/webvtt1/) formats for ingesting Subtitles and Closed Captions. * For Watermarking or Overlay, the URL is the location of the watermark image. * When creating clips from existing Mux assets, the URL is defined with `mux://assets/{asset_id}` template where `asset_id` is the Asset Identifier for creating the clip from. The url property may be omitted on the first input object when providing asset settings for LiveStream and Upload objects, in order to configure settings related to the primary (live stream or direct upload) input. + // The URL of the file that Mux should download and use. * For the main input file, this should be the URL to the muxed file for Mux to download, for example an MP4, MOV, MKV, or TS file. Mux supports most audio/video file formats and codecs, but for fastest processing, you should [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time). * For `audio` tracks, the URL is the location of the audio file for Mux to download, for example an M4A, WAV, or MP3 file. Mux supports most audio file formats and codecs, but for fastest processing, you should [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time). * For `text` tracks, the URL is the location of subtitle/captions file. Mux supports [SubRip Text (SRT)](https://en.wikipedia.org/wiki/SubRip) and [Web Video Text Tracks](https://www.w3.org/TR/webvtt1/) formats for ingesting Subtitles and Closed Captions. * For Watermarking or Overlay, the URL is the location of the watermark image. * When creating clips from existing Mux assets, the URL is defined with `mux://assets/{asset_id}` template where `asset_id` is the Asset Identifier for creating the clip from. The url property may be omitted on the first input object when providing asset settings for LiveStream and Upload objects, in order to configure settings related to the primary (live stream or direct upload) input. Url string `json:"url,omitempty"` OverlaySettings InputSettingsOverlaySettings `json:"overlay_settings,omitempty"` // Generate subtitle tracks using automatic speech recognition using this configuration. This may only be provided for the first input object (the main input file). For direct uploads, this first input should omit the url parameter, as the main input file is provided via the direct upload. This will create subtitles based on the audio track ingested from that main input file. Note that subtitle generation happens after initial ingest, so the generated tracks will be in the `preparing` state when the asset transitions to `ready`. diff --git a/model_insight.go b/model_insight.go index 67ef6ff..a95faed 100644 --- a/model_insight.go +++ b/model_insight.go @@ -5,6 +5,7 @@ package muxgo type Insight struct { TotalWatchTime int64 `json:"total_watch_time,omitempty"` + TotalPlayingTime int64 `json:"total_playing_time,omitempty"` TotalViews int64 `json:"total_views,omitempty"` NegativeImpactScore float32 `json:"negative_impact_score,omitempty"` Metric float64 `json:"metric,omitempty"` diff --git a/model_launch_web_input_response.go b/model_launch_web_input_response.go new file mode 100644 index 0000000..168a811 --- /dev/null +++ b/model_launch_web_input_response.go @@ -0,0 +1,8 @@ +// Mux Go - Copyright 2019 Mux Inc. +// NOTE: This file is auto generated. Do not edit this file manually. + +package muxgo + +type LaunchWebInputResponse struct { + Data map[string]interface{} `json:"data,omitempty"` +} diff --git a/model_list_breakdown_values_response.go b/model_list_breakdown_values_response.go index 96e371a..c108aa0 100644 --- a/model_list_breakdown_values_response.go +++ b/model_list_breakdown_values_response.go @@ -4,7 +4,8 @@ package muxgo type ListBreakdownValuesResponse struct { - Data []BreakdownValue `json:"data,omitempty"` - TotalRowCount int64 `json:"total_row_count,omitempty"` - Timeframe []int64 `json:"timeframe,omitempty"` + Data []BreakdownValue `json:"data,omitempty"` + TotalRowCount int64 `json:"total_row_count,omitempty"` + Timeframe []int64 `json:"timeframe,omitempty"` + Meta ListBreakdownValuesResponseMeta `json:"meta,omitempty"` } diff --git a/model_list_breakdown_values_response_meta.go b/model_list_breakdown_values_response_meta.go new file mode 100644 index 0000000..f249d63 --- /dev/null +++ b/model_list_breakdown_values_response_meta.go @@ -0,0 +1,9 @@ +// Mux Go - Copyright 2019 Mux Inc. +// NOTE: This file is auto generated. Do not edit this file manually. + +package muxgo + +type ListBreakdownValuesResponseMeta struct { + Granularity string `json:"granularity,omitempty"` + Aggregation string `json:"aggregation,omitempty"` +} diff --git a/model_list_insights_response.go b/model_list_insights_response.go index c35bce5..96a4682 100644 --- a/model_list_insights_response.go +++ b/model_list_insights_response.go @@ -4,7 +4,8 @@ package muxgo type ListInsightsResponse struct { - Data []Insight `json:"data,omitempty"` - TotalRowCount int64 `json:"total_row_count,omitempty"` - Timeframe []int64 `json:"timeframe,omitempty"` + Data []Insight `json:"data,omitempty"` + TotalRowCount int64 `json:"total_row_count,omitempty"` + Timeframe []int64 `json:"timeframe,omitempty"` + Meta ListBreakdownValuesResponseMeta `json:"meta,omitempty"` } diff --git a/model_list_web_inputs_response.go b/model_list_web_inputs_response.go new file mode 100644 index 0000000..7224186 --- /dev/null +++ b/model_list_web_inputs_response.go @@ -0,0 +1,8 @@ +// Mux Go - Copyright 2019 Mux Inc. +// NOTE: This file is auto generated. Do not edit this file manually. + +package muxgo + +type ListWebInputsResponse struct { + Data []WebInput `json:"data,omitempty"` +} diff --git a/model_live_stream.go b/model_live_stream.go index 3a5fd77..90f06b4 100644 --- a/model_live_stream.go +++ b/model_live_stream.go @@ -15,7 +15,7 @@ type LiveStream struct { // An array of strings with the most recent Asset IDs that were created from this Live Stream. The most recently generated Asset ID is the last entry in the list. RecentAssetIds []string `json:"recent_asset_ids,omitempty"` Status LiveStreamStatus `json:"status,omitempty"` - // An array of Playback ID objects. Use these to create HLS playback URLs. See [Play your videos](https://docs.mux.com/guides/video/play-your-videos) for more details. + // An array of Playback ID objects. Use these to create HLS playback URLs. See [Play your videos](https://docs.mux.com/guides/play-your-videos) for more details. PlaybackIds []PlaybackId `json:"playback_ids,omitempty"` NewAssetSettings CreateAssetRequest `json:"new_asset_settings,omitempty"` // Arbitrary user-supplied metadata set for the asset. Max 255 characters. @@ -32,13 +32,13 @@ type LiveStream struct { UseSlateForStandardLatency bool `json:"use_slate_for_standard_latency,omitempty"` // The URL of the image file that Mux should download and use as slate media during interruptions of the live stream media. This file will be downloaded each time a new recorded asset is created from the live stream. If this is not set, the default slate media will be used. ReconnectSlateUrl string `json:"reconnect_slate_url,omitempty"` - // This field is deprecated. Please use `latency_mode` instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this if you want lower latency for your live stream. See the [Reduce live stream latency guide](https://docs.mux.com/guides/video/reduce-live-stream-latency) to understand the tradeoffs. + // This field is deprecated. Please use `latency_mode` instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this if you want lower latency for your live stream. See the [Reduce live stream latency guide](https://docs.mux.com/guides/reduce-live-stream-latency) to understand the tradeoffs. ReducedLatency bool `json:"reduced_latency,omitempty"` // This field is deprecated. Please use `latency_mode` instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Setting this option will enable compatibility with the LL-HLS specification for low-latency streaming. This typically has lower latency than Reduced Latency streams, and cannot be combined with Reduced Latency. LowLatency bool `json:"low_latency,omitempty"` - // Each Simulcast Target contains configuration details to broadcast (or \"restream\") a live stream to a third-party streaming service. [See the Stream live to 3rd party platforms guide](https://docs.mux.com/guides/video/stream-live-to-3rd-party-platforms). + // Each Simulcast Target contains configuration details to broadcast (or \"restream\") a live stream to a third-party streaming service. [See the Stream live to 3rd party platforms guide](https://docs.mux.com/guides/stream-live-to-3rd-party-platforms). SimulcastTargets []SimulcastTarget `json:"simulcast_targets,omitempty"` - // Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags. The Low Latency value is a beta feature. Read more here: https://mux.com/blog/introducing-low-latency-live-streaming/ + // Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags. LatencyMode string `json:"latency_mode,omitempty"` // True means this live stream is a test live stream. Test live streams can be used to help evaluate the Mux Video APIs for free. There is no limit on the number of test live streams, but they are watermarked with the Mux logo, and limited to 5 minutes. The test live stream is disabled after the stream is active for 5 mins and the recorded asset also deleted after 24 hours. Test bool `json:"test,omitempty"` diff --git a/model_monitoring_breakdown_value.go b/model_monitoring_breakdown_value.go index b2a3e11..63c26e6 100644 --- a/model_monitoring_breakdown_value.go +++ b/model_monitoring_breakdown_value.go @@ -9,4 +9,5 @@ type MonitoringBreakdownValue struct { MetricValue float64 `json:"metric_value,omitempty"` DisplayValue string `json:"display_value,omitempty"` ConcurrentViewers int64 `json:"concurrent_viewers,omitempty"` + StartingUpViewers int64 `json:"starting_up_viewers,omitempty"` } diff --git a/model_overall_values.go b/model_overall_values.go index 8299d08..dab2c1c 100644 --- a/model_overall_values.go +++ b/model_overall_values.go @@ -4,8 +4,9 @@ package muxgo type OverallValues struct { - Value float64 `json:"value,omitempty"` - TotalWatchTime int64 `json:"total_watch_time,omitempty"` - TotalViews int64 `json:"total_views,omitempty"` - GlobalValue float64 `json:"global_value,omitempty"` + Value float64 `json:"value,omitempty"` + TotalWatchTime int64 `json:"total_watch_time,omitempty"` + TotalViews int64 `json:"total_views,omitempty"` + TotalPlayingTime int64 `json:"total_playing_time,omitempty"` + GlobalValue float64 `json:"global_value,omitempty"` } diff --git a/model_playback_policy.go b/model_playback_policy.go index 3605e54..0f426ee 100644 --- a/model_playback_policy.go +++ b/model_playback_policy.go @@ -3,7 +3,7 @@ package muxgo -// PlaybackPolicy : * `public` playback IDs are accessible by constructing an HLS URL like `https://stream.mux.com/${PLAYBACK_ID}` * `signed` playback IDs should be used with tokens `https://stream.mux.com/${PLAYBACK_ID}?token={TOKEN}`. See [Secure video playback](https://docs.mux.com/guides/video/secure-video-playback) for details about creating tokens. +// PlaybackPolicy : * `public` playback IDs are accessible by constructing an HLS URL like `https://stream.mux.com/${PLAYBACK_ID}` * `signed` playback IDs should be used with tokens `https://stream.mux.com/${PLAYBACK_ID}?token={TOKEN}`. See [Secure video playback](https://docs.mux.com/guides/secure-video-playback) for details about creating tokens. type PlaybackPolicy string // List of PlaybackPolicy diff --git a/model_real_time_breakdown_value.go b/model_real_time_breakdown_value.go index 718e71f..42565f5 100644 --- a/model_real_time_breakdown_value.go +++ b/model_real_time_breakdown_value.go @@ -9,4 +9,5 @@ type RealTimeBreakdownValue struct { MetricValue float64 `json:"metric_value,omitempty"` DisplayValue string `json:"display_value,omitempty"` ConcurrentViewers int64 `json:"concurrent_viewers,omitempty"` + StartingUpViewers int64 `json:"starting_up_viewers,omitempty"` } diff --git a/model_reload_web_input_response.go b/model_reload_web_input_response.go new file mode 100644 index 0000000..f796b9d --- /dev/null +++ b/model_reload_web_input_response.go @@ -0,0 +1,8 @@ +// Mux Go - Copyright 2019 Mux Inc. +// NOTE: This file is auto generated. Do not edit this file manually. + +package muxgo + +type ReloadWebInputResponse struct { + Data map[string]interface{} `json:"data,omitempty"` +} diff --git a/model_score.go b/model_score.go index a489c13..fc23df4 100644 --- a/model_score.go +++ b/model_score.go @@ -4,10 +4,15 @@ package muxgo type Score struct { - WatchTime int64 `json:"watch_time,omitempty"` - ViewCount int64 `json:"view_count,omitempty"` - Name string `json:"name,omitempty"` - Value float64 `json:"value,omitempty"` - Metric string `json:"metric,omitempty"` - Items []Metric `json:"items,omitempty"` + WatchTime int64 `json:"watch_time,omitempty"` + ViewCount int64 `json:"view_count,omitempty"` + UniqueViewers int64 `json:"unique_viewers,omitempty"` + StartedViews int64 `json:"started_views,omitempty"` + TotalPlayingTime int64 `json:"total_playing_time,omitempty"` + Name string `json:"name,omitempty"` + EndedViews int64 `json:"ended_views,omitempty"` + Value float64 `json:"value,omitempty"` + Type string `json:"type,omitempty"` + Metric string `json:"metric,omitempty"` + Items []Metric `json:"items,omitempty"` } diff --git a/model_shutdown_web_input_response.go b/model_shutdown_web_input_response.go new file mode 100644 index 0000000..159ed1e --- /dev/null +++ b/model_shutdown_web_input_response.go @@ -0,0 +1,8 @@ +// Mux Go - Copyright 2019 Mux Inc. +// NOTE: This file is auto generated. Do not edit this file manually. + +package muxgo + +type ShutdownWebInputResponse struct { + Data map[string]interface{} `json:"data,omitempty"` +} diff --git a/model_update_live_stream_request.go b/model_update_live_stream_request.go index c8eb5f4..87d405f 100644 --- a/model_update_live_stream_request.go +++ b/model_update_live_stream_request.go @@ -6,7 +6,7 @@ package muxgo type UpdateLiveStreamRequest struct { // Arbitrary user-supplied metadata set for the live stream. Max 255 characters. In order to clear this value, the field should be included with an empty-string value. Passthrough string `json:"passthrough,omitempty"` - // Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags. The Low Latency value is a beta feature. Read more here: https://mux.com/blog/introducing-low-latency-live-streaming/ + // Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags. LatencyMode string `json:"latency_mode,omitempty"` // When live streaming software disconnects from Mux, either intentionally or due to a drop in the network, the Reconnect Window is the time in seconds that Mux should wait for the streaming software to reconnect before considering the live stream finished and completing the recorded asset. If not specified directly, Standard Latency streams have a Reconnect Window of 60 seconds; Reduced and Low Latency streams have a default of 0 seconds, or no Reconnect Window. For that reason, we suggest specifying a value other than zero for Reduced and Low Latency streams. Reduced and Low Latency streams with a Reconnect Window greater than zero will insert slate media into the recorded asset while waiting for the streaming software to reconnect or when there are brief interruptions in the live stream media. When using a Reconnect Window setting higher than 60 seconds with a Standard Latency stream, we highly recommend enabling slate with the `use_slate_for_standard_latency` option. ReconnectWindow float32 `json:"reconnect_window,omitempty"` diff --git a/model_update_web_input_url_request.go b/model_update_web_input_url_request.go new file mode 100644 index 0000000..8d20a2d --- /dev/null +++ b/model_update_web_input_url_request.go @@ -0,0 +1,9 @@ +// Mux Go - Copyright 2019 Mux Inc. +// NOTE: This file is auto generated. Do not edit this file manually. + +package muxgo + +type UpdateWebInputUrlRequest struct { + // The URL for the Web Input to load. + Url string `json:"url,omitempty"` +} diff --git a/model_video_view.go b/model_video_view.go index b10fba1..950f7c8 100644 --- a/model_video_view.go +++ b/model_video_view.go @@ -145,4 +145,6 @@ type VideoView struct { ViewDroppedFrameCount int64 `json:"view_dropped_frame_count,omitempty"` ViewHasAd bool `json:"view_has_ad,omitempty"` VideoStartupFailure bool `json:"video_startup_failure,omitempty"` + LongResume bool `json:"long_resume,omitempty"` + LongRebuffering bool `json:"long_rebuffering,omitempty"` } diff --git a/model_video_view_event.go b/model_video_view_event.go index 5c250a2..c88877c 100644 --- a/model_video_view_event.go +++ b/model_video_view_event.go @@ -4,8 +4,9 @@ package muxgo type VideoViewEvent struct { - ViewerTime int64 `json:"viewer_time,omitempty"` - PlaybackTime int64 `json:"playback_time,omitempty"` - Name string `json:"name,omitempty"` - EventTime int64 `json:"event_time,omitempty"` + ViewerTime int64 `json:"viewer_time,omitempty"` + PlaybackTime int64 `json:"playback_time,omitempty"` + Name string `json:"name,omitempty"` + EventTime int64 `json:"event_time,omitempty"` + Details map[string]map[string]interface{} `json:"details,omitempty"` } diff --git a/model_video_view_response.go b/model_video_view_response.go index b73626b..dacb74d 100644 --- a/model_video_view_response.go +++ b/model_video_view_response.go @@ -4,6 +4,7 @@ package muxgo type VideoViewResponse struct { - Data VideoView `json:"data,omitempty"` - Timeframe []int64 `json:"timeframe,omitempty"` + Data VideoView `json:"data,omitempty"` + Timeframe []int64 `json:"timeframe,omitempty"` + TotalRowCount int64 `json:"total_row_count,omitempty"` } diff --git a/model_web_input.go b/model_web_input.go new file mode 100644 index 0000000..1ff0c92 --- /dev/null +++ b/model_web_input.go @@ -0,0 +1,24 @@ +// Mux Go - Copyright 2019 Mux Inc. +// NOTE: This file is auto generated. Do not edit this file manually. + +package muxgo + +type WebInput struct { + // Unique identifier for the Web Input. + Id string `json:"id,omitempty"` + // Time the Web Input was created, defined as a Unix timestamp (seconds since epoch). + CreatedAt string `json:"created_at,omitempty"` + // The URL for the Web Input to load. + Url string `json:"url,omitempty"` + // When set to `true` the Web Input will automatically launch and start streaming immediately after creation + AutoLaunch bool `json:"auto_launch,omitempty"` + // The Live Stream ID to broadcast this Web Input to + LiveStreamId string `json:"live_stream_id,omitempty"` + Status string `json:"status,omitempty"` + // Arbitrary metadata that will be included in the Web Input details and related webhooks. Can be used to store your own ID for the Web Input. **Max: 255 characters**. + Passthrough string `json:"passthrough,omitempty"` + // The resolution of the viewport of the Web Input's browser instance. Defaults to 1920x1080 if not set. + Resolution string `json:"resolution,omitempty"` + // The number of seconds that the Web Input should stream for before automatically shutting down. + Timeout int32 `json:"timeout,omitempty"` +} diff --git a/model_web_input_response.go b/model_web_input_response.go new file mode 100644 index 0000000..9356ba8 --- /dev/null +++ b/model_web_input_response.go @@ -0,0 +1,8 @@ +// Mux Go - Copyright 2019 Mux Inc. +// NOTE: This file is auto generated. Do not edit this file manually. + +package muxgo + +type WebInputResponse struct { + Data WebInput `json:"data,omitempty"` +}