Mux.Csharp.Sdk 0.6.0

<h1 align="center"><pre>mux-csharp</pre></h1>

<p align="center"> <a href="https://www.nuget.org/packages/Mux.Csharp.Sdk"><img src="https://img.shields.io/nuget/v/Mux.Csharp.Sdk" title="NuGet" /></a> <a href="https://github.com/muxinc/mux-csharp/workflows/ci.yaml"><img src="https://github.com/muxinc/mux-csharp/actions/workflows/ci.yaml/badge.svg" title="CI" /></a> </p> <p align="center"> <a href="https://www.nuget.org/packages/Mux.Csharp.Sdk">NuGet</a> | <a href="https://docs.mux.com">Mux Docs</a> | <a href="https://docs.mux.com/api-reference">Mux API Reference </a> </p>

Mux is how developers build online video. This API encompasses both Mux Video and Mux Data functionality to help you build your video-related projects better and faster than ever before.

PLEASE NOTE: This is an early build of the Mux C# SDK, as evidenced by its pre-1.0 status, but we're reasonably certain of its stability and usability against the Mux API.. Documentation is currently best-effort, but it'll improve over time! Instead of contacting Mux Support, please file an issue on this repository or email Mux DevEx for assistance.

• API version: v1
• SDK version: 0.6.0 https://docs.mux.com

<a name="frameworks-supported"></a>

Frameworks supported

• .NET Core >=1.0
• .NET Framework >=4.6
• Mono/Xamarin >=vNext

<a name="dependencies"></a>

Dependencies

• RestSharp - 106.11.4 or later
• Json.NET - 12.0.3 or later
• JsonSubTypes - 1.7.0 or later
• System.ComponentModel.Annotations - 4.7.0 or later

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742

<a name="installation"></a>

Installation

Generate the DLL using your preferred tool (e.g. dotnet build)

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using Mux.Csharp.Sdk.Api;
using Mux.Csharp.Sdk.Client;
using Mux.Csharp.Sdk.Model;

<a name="usage"></a>

Usage

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

<a name="getting-started"></a>

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using Mux.Csharp.Sdk.Api;
using Mux.Csharp.Sdk.Client;
using Mux.Csharp.Sdk.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            config.BasePath = "https://api.mux.com";
            // Configure HTTP basic authorization: accessToken
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";

            var apiInstance = new AssetsApi(config);
            var createAssetRequest = new CreateAssetRequest(); // CreateAssetRequest | 

            try
            {
                // Create an asset
                AssetResponse result = apiInstance.CreateAsset(createAssetRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling AssetsApi.CreateAsset: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

<a name="documentation-for-api-endpoints"></a>

Documentation for API Endpoints

All URIs are relative to https://api.mux.com

<a name="documentation-for-models"></a>

Documentation for Models

• Model.AbridgedVideoView
• Model.Asset
• Model.AssetErrors
• Model.AssetMaster
• Model.AssetNonStandardInputReasons
• Model.AssetRecordingTimes
• Model.AssetResponse
• Model.AssetStaticRenditions
• Model.AssetStaticRenditionsFiles
• Model.BreakdownValue
• Model.Broadcast
• Model.BroadcastLayout
• Model.BroadcastResolution
• Model.BroadcastResponse
• Model.BroadcastStatus
• Model.CreateAssetRequest
• Model.CreateBroadcastRequest
• Model.CreateLiveStreamRequest
• Model.CreatePlaybackIDRequest
• Model.CreatePlaybackIDResponse
• Model.CreatePlaybackRestrictionRequest
• Model.CreateSimulcastTargetRequest
• Model.CreateSpaceRequest
• Model.CreateTrackRequest
• Model.CreateTrackResponse
• Model.CreateTranscriptionVocabularyRequest
• Model.CreateUploadRequest
• Model.DeliveryReport
• Model.DeliveryReportDeliveredSecondsByResolution
• Model.DimensionValue
• Model.DisableLiveStreamResponse
• Model.EnableLiveStreamResponse
• Model.Error
• Model.ExportDate
• Model.ExportFile
• Model.FilterValue
• Model.GetAssetInputInfoResponse
• Model.GetAssetOrLiveStreamIdResponse
• Model.GetAssetOrLiveStreamIdResponseData
• Model.GetAssetOrLiveStreamIdResponseDataObject
• Model.GetAssetPlaybackIDResponse
• Model.GetLiveStreamPlaybackIDResponse
• Model.GetMetricTimeseriesDataResponse
• Model.GetMonitoringBreakdownResponse
• Model.GetMonitoringHistogramTimeseriesResponse
• Model.GetMonitoringHistogramTimeseriesResponseMeta
• Model.GetMonitoringTimeseriesResponse
• Model.GetOverallValuesResponse
• Model.GetRealTimeBreakdownResponse
• Model.GetRealTimeHistogramTimeseriesResponse
• Model.GetRealTimeHistogramTimeseriesResponseMeta
• Model.GetRealTimeTimeseriesResponse
• Model.Incident
• Model.IncidentBreakdown
• Model.IncidentNotification
• Model.IncidentNotificationRule
• Model.IncidentResponse
• Model.InputFile
• Model.InputInfo
• Model.InputSettings
• Model.InputSettingsOverlaySettings
• Model.InputTrack
• Model.Insight
• Model.ListAllMetricValuesResponse
• Model.ListAssetsResponse
• Model.ListBreakdownValuesResponse
• Model.ListDeliveryUsageResponse
• Model.ListDimensionValuesResponse
• Model.ListDimensionsResponse
• Model.ListErrorsResponse
• Model.ListExportsResponse
• Model.ListFilterValuesResponse
• Model.ListFiltersResponse
• Model.ListFiltersResponseData
• Model.ListIncidentsResponse
• Model.ListInsightsResponse
• Model.ListLiveStreamsResponse
• Model.ListMonitoringDimensionsResponse
• Model.ListMonitoringDimensionsResponseData
• Model.ListMonitoringMetricsResponse
• Model.ListPlaybackRestrictionsResponse
• Model.ListRealTimeDimensionsResponse
• Model.ListRealTimeMetricsResponse
• Model.ListRelatedIncidentsResponse
• Model.ListSigningKeysResponse
• Model.ListSpacesResponse
• Model.ListTranscriptionVocabulariesResponse
• Model.ListUploadsResponse
• Model.ListVideoViewExportsResponse
• Model.ListVideoViewsResponse
• Model.LiveStream
• Model.LiveStreamEmbeddedSubtitleSettings
• Model.LiveStreamGeneratedSubtitleSettings
• Model.LiveStreamResponse
• Model.LiveStreamStatus
• Model.Metric
• Model.MonitoringBreakdownValue
• Model.MonitoringHistogramTimeseriesBucket
• Model.MonitoringHistogramTimeseriesBucketValues
• Model.MonitoringHistogramTimeseriesDatapoint
• Model.MonitoringTimeseriesDatapoint
• Model.NotificationRule
• Model.OverallValues
• Model.PlaybackID
• Model.PlaybackPolicy
• Model.PlaybackRestriction
• Model.PlaybackRestrictionResponse
• Model.RealTimeBreakdownValue
• Model.RealTimeHistogramTimeseriesBucket
• Model.RealTimeHistogramTimeseriesBucketValues
• Model.RealTimeHistogramTimeseriesDatapoint
• Model.RealTimeTimeseriesDatapoint
• Model.ReferrerDomainRestriction
• Model.Score
• Model.SignalLiveStreamCompleteResponse
• Model.SigningKey
• Model.SigningKeyResponse
• Model.SimulcastTarget
• Model.SimulcastTargetResponse
• Model.Space
• Model.SpaceResponse
• Model.SpaceStatus
• Model.SpaceType
• Model.StartSpaceBroadcastResponse
• Model.StopSpaceBroadcastResponse
• Model.Track
• Model.TranscriptionVocabulary
• Model.TranscriptionVocabularyResponse
• Model.UpdateAssetMP4SupportRequest
• Model.UpdateAssetMasterAccessRequest
• Model.UpdateAssetRequest
• Model.UpdateLiveStreamEmbeddedSubtitlesRequest
• Model.UpdateLiveStreamGeneratedSubtitlesRequest
• Model.UpdateLiveStreamRequest
• Model.UpdateReferrerDomainRestrictionRequest
• Model.UpdateTranscriptionVocabularyRequest
• Model.Upload
• Model.UploadError
• Model.UploadResponse
• Model.VideoView
• Model.VideoViewEvent
• Model.VideoViewResponse

<a name="documentation-for-authorization"></a>

Documentation for Authorization

<a name="accessToken"></a>

accessToken

• Type: HTTP basic authentication