├── .github
├── dependabot.yml
└── workflows
│ ├── ci.yaml
│ └── release.yaml
├── .gitignore
├── .openapi-generator-ignore
├── .openapi-generator
├── FILES
└── VERSION
├── .tool-versions
├── .vscode
├── launch.json
└── tasks.json
├── CODEOWNERS
├── LICENSE
├── Mux.Csharp.Sdk.sln
├── README.md
├── docs
├── AbridgedVideoView.md
├── Asset.md
├── AssetErrors.md
├── AssetGeneratedSubtitleSettings.md
├── AssetMaster.md
├── AssetMetadata.md
├── AssetNonStandardInputReasons.md
├── AssetRecordingTimes.md
├── AssetResponse.md
├── AssetStaticRenditions.md
├── AssetsApi.md
├── BreakdownValue.md
├── CreateAssetRequest.md
├── CreateLiveStreamRequest.md
├── CreatePlaybackIDRequest.md
├── CreatePlaybackIDResponse.md
├── CreatePlaybackRestrictionRequest.md
├── CreateSimulcastTargetRequest.md
├── CreateStaticRenditionRequest.md
├── CreateStaticRenditionResponse.md
├── CreateTrackRequest.md
├── CreateTrackResponse.md
├── CreateTranscriptionVocabularyRequest.md
├── CreateUploadRequest.md
├── CreateWebInputRequest.md
├── DRMConfiguration.md
├── DRMConfigurationResponse.md
├── DRMConfigurationsApi.md
├── DeliveryReport.md
├── DeliveryReportDeliveredSecondsByResolution.md
├── DeliveryUsageApi.md
├── DimensionValue.md
├── DimensionsApi.md
├── DirectUploadsApi.md
├── DisableLiveStreamResponse.md
├── EnableLiveStreamResponse.md
├── Error.md
├── ErrorsApi.md
├── ExportDate.md
├── ExportFile.md
├── ExportsApi.md
├── FilterValue.md
├── FiltersApi.md
├── GenerateTrackSubtitlesRequest.md
├── GenerateTrackSubtitlesResponse.md
├── GetAssetInputInfoResponse.md
├── GetAssetOrLiveStreamIdResponse.md
├── GetAssetOrLiveStreamIdResponseData.md
├── GetAssetOrLiveStreamIdResponseDataObject.md
├── GetAssetPlaybackIDResponse.md
├── GetLiveStreamPlaybackIDResponse.md
├── GetMetricTimeseriesDataResponse.md
├── GetMonitoringBreakdownResponse.md
├── GetMonitoringBreakdownTimeseriesResponse.md
├── GetMonitoringHistogramTimeseriesResponse.md
├── GetMonitoringHistogramTimeseriesResponseMeta.md
├── GetMonitoringTimeseriesResponse.md
├── GetOverallValuesResponse.md
├── GetRealTimeBreakdownResponse.md
├── GetRealTimeHistogramTimeseriesResponse.md
├── GetRealTimeHistogramTimeseriesResponseMeta.md
├── GetRealTimeTimeseriesResponse.md
├── Incident.md
├── IncidentBreakdown.md
├── IncidentNotification.md
├── IncidentNotificationRule.md
├── IncidentResponse.md
├── IncidentsApi.md
├── InputFile.md
├── InputInfo.md
├── InputSettings.md
├── InputSettingsOverlaySettings.md
├── InputTrack.md
├── Insight.md
├── LaunchWebInputResponse.md
├── ListAllMetricValuesResponse.md
├── ListAssetsResponse.md
├── ListBreakdownValuesResponse.md
├── ListBreakdownValuesResponseMeta.md
├── ListDRMConfigurationsResponse.md
├── ListDeliveryUsageResponse.md
├── ListDimensionValuesResponse.md
├── ListDimensionsResponse.md
├── ListErrorsResponse.md
├── ListExportsResponse.md
├── ListFilterValuesResponse.md
├── ListFiltersResponse.md
├── ListFiltersResponseData.md
├── ListIncidentsResponse.md
├── ListInsightsResponse.md
├── ListLiveStreamsResponse.md
├── ListMonitoringDimensionsResponse.md
├── ListMonitoringDimensionsResponseData.md
├── ListMonitoringMetricsResponse.md
├── ListPlaybackRestrictionsResponse.md
├── ListRealTimeDimensionsResponse.md
├── ListRealTimeMetricsResponse.md
├── ListRelatedIncidentsResponse.md
├── ListSigningKeysResponse.md
├── ListTranscriptionVocabulariesResponse.md
├── ListUploadsResponse.md
├── ListVideoViewExportsResponse.md
├── ListVideoViewsResponse.md
├── ListWebInputsResponse.md
├── LiveStream.md
├── LiveStreamEmbeddedSubtitleSettings.md
├── LiveStreamGeneratedSubtitleSettings.md
├── LiveStreamResponse.md
├── LiveStreamStatus.md
├── LiveStreamsApi.md
├── Metric.md
├── MetricsApi.md
├── MonitoringApi.md
├── MonitoringBreakdownTimeseriesDatapoint.md
├── MonitoringBreakdownTimeseriesValues.md
├── MonitoringBreakdownValue.md
├── MonitoringHistogramTimeseriesBucket.md
├── MonitoringHistogramTimeseriesBucketValues.md
├── MonitoringHistogramTimeseriesDatapoint.md
├── MonitoringTimeseriesDatapoint.md
├── NotificationRule.md
├── OverallValues.md
├── PlaybackID.md
├── PlaybackIDApi.md
├── PlaybackPolicy.md
├── PlaybackRestriction.md
├── PlaybackRestrictionResponse.md
├── PlaybackRestrictionsApi.md
├── RealTimeApi.md
├── RealTimeBreakdownValue.md
├── RealTimeHistogramTimeseriesBucket.md
├── RealTimeHistogramTimeseriesBucketValues.md
├── RealTimeHistogramTimeseriesDatapoint.md
├── RealTimeTimeseriesDatapoint.md
├── ReferrerDomainRestriction.md
├── ReloadWebInputResponse.md
├── Score.md
├── ShutdownWebInputResponse.md
├── SignalLiveStreamCompleteResponse.md
├── SigningKey.md
├── SigningKeyResponse.md
├── SigningKeysApi.md
├── SimulcastTarget.md
├── SimulcastTargetResponse.md
├── StaticRendition.md
├── Track.md
├── TranscriptionVocabulariesApi.md
├── TranscriptionVocabulary.md
├── TranscriptionVocabularyResponse.md
├── URLSigningKeysApi.md
├── UpdateAssetMP4SupportRequest.md
├── UpdateAssetMasterAccessRequest.md
├── UpdateAssetRequest.md
├── UpdateLiveStreamEmbeddedSubtitlesRequest.md
├── UpdateLiveStreamGeneratedSubtitlesRequest.md
├── UpdateLiveStreamNewAssetSettings.md
├── UpdateLiveStreamNewAssetSettingsStaticRenditionsRequest.md
├── UpdateLiveStreamRequest.md
├── UpdateReferrerDomainRestrictionRequest.md
├── UpdateTranscriptionVocabularyRequest.md
├── UpdateUserAgentRestrictionRequest.md
├── UpdateWebInputUrlRequest.md
├── Upload.md
├── UploadError.md
├── UploadResponse.md
├── UserAgentRestrictionRequest.md
├── UserAgentRestrictionSettings.md
├── VideoView.md
├── VideoViewEvent.md
├── VideoViewResponse.md
├── VideoViewsApi.md
├── WebInput.md
├── WebInputResponse.md
└── WebInputsApi.md
├── gen
├── .gitignore
├── Makefile
├── generator-config.json
├── openapitools.json
├── package.json
├── templates
│ ├── AbstractOpenAPISchema.mustache
│ ├── ApiClient.mustache
│ ├── ApiException.mustache
│ ├── ApiResponse.mustache
│ ├── AssemblyInfo.mustache
│ ├── ClientUtils.mustache
│ ├── Configuration.mustache
│ ├── ExceptionFactory.mustache
│ ├── GlobalConfiguration.mustache
│ ├── HttpMethod.mustache
│ ├── HttpSigningConfiguration.mustache
│ ├── IApiAccessor.mustache
│ ├── IAsynchronousClient.mustache
│ ├── IReadableConfiguration.mustache
│ ├── ISynchronousClient.mustache
│ ├── JsonSubTypesTests.mustache
│ ├── Multimap.mustache
│ ├── OpenAPIDateConverter.mustache
│ ├── README.mustache
│ ├── ReadOnlyDictionary.mustache
│ ├── RequestOptions.mustache
│ ├── RetryConfiguration.mustache
│ ├── Solution.mustache
│ ├── TestProject.mustache
│ ├── WebRequestPathBuilder.mustache
│ ├── api.mustache
│ ├── api_doc.mustache
│ ├── api_test.mustache
│ ├── appveyor.mustache
│ ├── git_push.sh.mustache
│ ├── gitignore.mustache
│ ├── libraries
│ │ ├── generichost
│ │ │ ├── ApiException.mustache
│ │ │ ├── ApiKeyToken.mustache
│ │ │ ├── ApiResponseEventArgs.mustache
│ │ │ ├── ApiResponse`1.mustache
│ │ │ ├── ApiTestsBase.mustache
│ │ │ ├── BasicToken.mustache
│ │ │ ├── BearerToken.mustache
│ │ │ ├── ClientUtils.mustache
│ │ │ ├── DependencyInjectionTests.mustache
│ │ │ ├── HostConfiguration.mustache
│ │ │ ├── HttpSigningConfiguration.mustache
│ │ │ ├── HttpSigningToken.mustache
│ │ │ ├── IApi.mustache
│ │ │ ├── OAuthToken.mustache
│ │ │ ├── README.mustache
│ │ │ ├── RateLimitProvider`1.mustache
│ │ │ ├── TokenBase.mustache
│ │ │ ├── TokenContainer`1.mustache
│ │ │ ├── TokenProvider`1.mustache
│ │ │ ├── api.mustache
│ │ │ ├── api_test.mustache
│ │ │ ├── git_push.ps1.mustache
│ │ │ └── git_push.sh.mustache
│ │ └── httpclient
│ │ │ ├── ApiClient.mustache
│ │ │ ├── FileParameter.mustache
│ │ │ ├── RequestOptions.mustache
│ │ │ ├── api.mustache
│ │ │ └── model.mustache
│ ├── model.mustache
│ ├── modelAnyOf.mustache
│ ├── modelEnum.mustache
│ ├── modelGeneric.mustache
│ ├── modelInnerEnum.mustache
│ ├── modelOneOf.mustache
│ ├── model_doc.mustache
│ ├── model_test.mustache
│ ├── netcore_project.mustache
│ ├── netcore_testproject.mustache
│ ├── nuspec.mustache
│ ├── partial_header.mustache
│ └── visibility.mustache
└── yarn.lock
├── icon.png
└── src
├── Mux.Csharp.Sdk.Test
├── Mux.Csharp.Sdk.Test.csproj
├── TestHelpers.cs
└── Video
│ └── ExerciseAssets.cs
└── Mux.Csharp.Sdk
├── Api
├── AssetsApi.cs
├── DRMConfigurationsApi.cs
├── DeliveryUsageApi.cs
├── DimensionsApi.cs
├── DirectUploadsApi.cs
├── ErrorsApi.cs
├── ExportsApi.cs
├── FiltersApi.cs
├── IncidentsApi.cs
├── LiveStreamsApi.cs
├── MetricsApi.cs
├── MonitoringApi.cs
├── PlaybackIDApi.cs
├── PlaybackRestrictionsApi.cs
├── RealTimeApi.cs
├── SigningKeysApi.cs
├── SpacesApi.cs
├── TranscriptionVocabulariesApi.cs
├── URLSigningKeysApi.cs
├── VideoViewsApi.cs
└── WebInputsApi.cs
├── Client
├── ApiClient.cs
├── ApiException.cs
├── ApiResponse.cs
├── ClientUtils.cs
├── Configuration.cs
├── ExceptionFactory.cs
├── GlobalConfiguration.cs
├── HttpMethod.cs
├── IApiAccessor.cs
├── IAsynchronousClient.cs
├── IReadableConfiguration.cs
├── ISynchronousClient.cs
├── Multimap.cs
├── OpenAPIDateConverter.cs
├── RequestOptions.cs
└── RetryConfiguration.cs
├── Model
├── AbridgedVideoView.cs
├── AbstractOpenAPISchema.cs
├── Asset.cs
├── AssetErrors.cs
├── AssetGeneratedSubtitleSettings.cs
├── AssetMaster.cs
├── AssetMetadata.cs
├── AssetNonStandardInputReasons.cs
├── AssetRecordingTimes.cs
├── AssetResponse.cs
├── AssetStaticRenditions.cs
├── AssetStaticRenditionsFiles.cs
├── BreakdownValue.cs
├── Broadcast.cs
├── BroadcastLayout.cs
├── BroadcastResolution.cs
├── BroadcastResponse.cs
├── BroadcastStatus.cs
├── CreateAssetRequest.cs
├── CreateBroadcastRequest.cs
├── CreateLiveStreamRequest.cs
├── CreatePlaybackIDRequest.cs
├── CreatePlaybackIDResponse.cs
├── CreatePlaybackRestrictionRequest.cs
├── CreateSimulcastTargetRequest.cs
├── CreateSpaceRequest.cs
├── CreateStaticRenditionRequest.cs
├── CreateStaticRenditionResponse.cs
├── CreateTrackRequest.cs
├── CreateTrackResponse.cs
├── CreateTranscriptionVocabularyRequest.cs
├── CreateUploadRequest.cs
├── CreateWebInputRequest.cs
├── DRMConfiguration.cs
├── DRMConfigurationResponse.cs
├── DeliveryReport.cs
├── DeliveryReportDeliveredSecondsByResolution.cs
├── DimensionValue.cs
├── DisableLiveStreamResponse.cs
├── EnableLiveStreamResponse.cs
├── Error.cs
├── ExportDate.cs
├── ExportFile.cs
├── FilterValue.cs
├── GenerateTrackSubtitlesRequest.cs
├── GenerateTrackSubtitlesResponse.cs
├── GetAssetInputInfoResponse.cs
├── GetAssetOrLiveStreamIdResponse.cs
├── GetAssetOrLiveStreamIdResponseData.cs
├── GetAssetOrLiveStreamIdResponseDataObject.cs
├── GetAssetPlaybackIDResponse.cs
├── GetLiveStreamPlaybackIDResponse.cs
├── GetMetricTimeseriesDataResponse.cs
├── GetMonitoringBreakdownResponse.cs
├── GetMonitoringBreakdownTimeseriesResponse.cs
├── GetMonitoringHistogramTimeseriesResponse.cs
├── GetMonitoringHistogramTimeseriesResponseMeta.cs
├── GetMonitoringTimeseriesResponse.cs
├── GetOverallValuesResponse.cs
├── GetRealTimeBreakdownResponse.cs
├── GetRealTimeHistogramTimeseriesResponse.cs
├── GetRealTimeHistogramTimeseriesResponseMeta.cs
├── GetRealTimeTimeseriesResponse.cs
├── Incident.cs
├── IncidentBreakdown.cs
├── IncidentNotification.cs
├── IncidentNotificationRule.cs
├── IncidentResponse.cs
├── InputFile.cs
├── InputInfo.cs
├── InputSettings.cs
├── InputSettingsOverlaySettings.cs
├── InputTrack.cs
├── Insight.cs
├── LaunchWebInputResponse.cs
├── ListAllMetricValuesResponse.cs
├── ListAssetsResponse.cs
├── ListBreakdownValuesResponse.cs
├── ListBreakdownValuesResponseMeta.cs
├── ListDRMConfigurationsResponse.cs
├── ListDeliveryUsageResponse.cs
├── ListDimensionValuesResponse.cs
├── ListDimensionsResponse.cs
├── ListErrorsResponse.cs
├── ListExportsResponse.cs
├── ListFilterValuesResponse.cs
├── ListFiltersResponse.cs
├── ListFiltersResponseData.cs
├── ListIncidentsResponse.cs
├── ListInsightsResponse.cs
├── ListLiveStreamsResponse.cs
├── ListMonitoringDimensionsResponse.cs
├── ListMonitoringDimensionsResponseData.cs
├── ListMonitoringMetricsResponse.cs
├── ListPlaybackRestrictionsResponse.cs
├── ListRealTimeDimensionsResponse.cs
├── ListRealTimeDimensionsResponseData.cs
├── ListRealTimeMetricsResponse.cs
├── ListRelatedIncidentsResponse.cs
├── ListSigningKeysResponse.cs
├── ListSpacesResponse.cs
├── ListTranscriptionVocabulariesResponse.cs
├── ListUploadsResponse.cs
├── ListVideoViewExportsResponse.cs
├── ListVideoViewsResponse.cs
├── ListWebInputsResponse.cs
├── LiveStream.cs
├── LiveStreamEmbeddedSubtitleSettings.cs
├── LiveStreamGeneratedSubtitleSettings.cs
├── LiveStreamResponse.cs
├── LiveStreamStatus.cs
├── Metric.cs
├── MonitoringBreakdownTimeseriesDatapoint.cs
├── MonitoringBreakdownTimeseriesValues.cs
├── MonitoringBreakdownValue.cs
├── MonitoringHistogramTimeseriesBucket.cs
├── MonitoringHistogramTimeseriesBucketValues.cs
├── MonitoringHistogramTimeseriesDatapoint.cs
├── MonitoringTimeseriesDatapoint.cs
├── NotificationRule.cs
├── OverallValues.cs
├── PlaybackID.cs
├── PlaybackPolicy.cs
├── PlaybackRestriction.cs
├── PlaybackRestrictionResponse.cs
├── RealTimeBreakdownValue.cs
├── RealTimeHistogramTimeseriesBucket.cs
├── RealTimeHistogramTimeseriesBucketValues.cs
├── RealTimeHistogramTimeseriesDatapoint.cs
├── RealTimeTimeseriesDatapoint.cs
├── ReferrerDomainRestriction.cs
├── ReloadWebInputResponse.cs
├── Score.cs
├── ShutdownWebInputResponse.cs
├── SignalLiveStreamCompleteResponse.cs
├── SigningKey.cs
├── SigningKeyResponse.cs
├── SimulcastTarget.cs
├── SimulcastTargetResponse.cs
├── Space.cs
├── SpaceResponse.cs
├── SpaceStatus.cs
├── SpaceType.cs
├── StartSpaceBroadcastResponse.cs
├── StaticRendition.cs
├── StopSpaceBroadcastResponse.cs
├── Track.cs
├── TranscriptionVocabulary.cs
├── TranscriptionVocabularyResponse.cs
├── UpdateAssetMP4SupportRequest.cs
├── UpdateAssetMasterAccessRequest.cs
├── UpdateAssetRequest.cs
├── UpdateLiveStreamEmbeddedSubtitlesRequest.cs
├── UpdateLiveStreamGeneratedSubtitlesRequest.cs
├── UpdateLiveStreamNewAssetSettings.cs
├── UpdateLiveStreamNewAssetSettingsStaticRenditionsRequest.cs
├── UpdateLiveStreamRequest.cs
├── UpdateReferrerDomainRestrictionRequest.cs
├── UpdateTranscriptionVocabularyRequest.cs
├── UpdateUserAgentRestrictionRequest.cs
├── UpdateWebInputUrlRequest.cs
├── Upload.cs
├── UploadError.cs
├── UploadResponse.cs
├── UserAgentRestrictionRequest.cs
├── UserAgentRestrictionSettings.cs
├── VideoView.cs
├── VideoViewEvent.cs
├── VideoViewResponse.cs
├── WebInput.cs
└── WebInputResponse.cs
├── Mux.Csharp.Sdk.csproj
├── README.md
└── icon.png
/.github/dependabot.yml:
--------------------------------------------------------------------------------
1 | # To get started with Dependabot version updates, you'll need to specify which
2 | # package ecosystems to update and where the package manifests are located.
3 | # Please see the documentation for all configuration options:
4 | # https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
5 |
6 | version: 2
7 | updates:
8 | - package-ecosystem: "nuget"
9 | directory: "/" # Location of package manifests
10 | schedule:
11 | interval: "daily"
12 |
13 | - package-ecosystem: "github-actions"
14 | directory: "/" # Location of package manifests
15 | schedule:
16 | interval: "daily"
--------------------------------------------------------------------------------
/.github/workflows/ci.yaml:
--------------------------------------------------------------------------------
1 | ---
2 | name: CI
3 | on:
4 | push:
5 | branches: [main]
6 | pull_request:
7 | branches: [main]
8 |
9 | jobs:
10 | build:
11 | runs-on: ubuntu-latest
12 |
13 | strategy:
14 | matrix:
15 | dotnet-configuration: [Debug, Release]
16 |
17 | steps:
18 | - name: Install .NET
19 | uses: actions/setup-dotnet@v4
20 | with:
21 | dotnet-version: '3.1.x'
22 | - name: Install OpenSSL 1.1
23 | run: |
24 | wget https://archive.ubuntu.com/ubuntu/pool/main/o/openssl/libssl1.1_1.1.0g-2ubuntu4_amd64.deb
25 | sudo dpkg -i libssl1.1_1.1.0g-2ubuntu4_amd64.deb
26 | - name: Check out code
27 | uses: actions/checkout@v4
28 | - name: Adding /tmp/output
29 | run: mkdir -p /tmp/output
30 |
31 | - name: Build for ${{ matrix.dotnet-configuration }}
32 | run: dotnet build --configuration ${{ matrix.dotnet-configuration }}
33 | - name: Test for ${{ matrix.dotnet-configuration }}
34 | env:
35 | MUX_TOKEN_ID: "${{ secrets.MUX_TOKEN_ID }}"
36 | MUX_TOKEN_SECRET: "${{ secrets.MUX_TOKEN_SECRET }}"
37 | run: dotnet test --configuration ${{ matrix.dotnet-configuration }} --no-build
38 | - name: Pack for ${{ matrix.dotnet-configuration }}
39 | run: cp README.md icon.png src/Mux.Csharp.Sdk && dotnet pack --configuration ${{ matrix.dotnet-configuration }} --no-build --include-source --include-symbols --output /tmp/output
40 |
41 | - name: Uploading artifact for ${{ matrix.dotnet-configuration }}
42 | uses: actions/upload-artifact@v4
43 | with:
44 | name: Mux.Csharp.Sdk-${{ matrix.dotnet-configuration }}
45 | path: /tmp/output/*
46 |
--------------------------------------------------------------------------------
/.openapi-generator-ignore:
--------------------------------------------------------------------------------
1 | # OpenAPI Generator Ignore
2 | # Generated by openapi-generator https://github.com/openapitools/openapi-generator
3 |
4 | # Use this file to prevent files from being overwritten by the generator.
5 | # The patterns follow closely to .gitignore or .dockerignore.
6 |
7 | # As an example, the C# client generator defines ApiClient.cs.
8 | # You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
9 | #ApiClient.cs
10 |
11 | # You can match any string of characters against a directory, file or extension with a single asterisk (*):
12 | #foo/*/qux
13 | # The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
14 |
15 | # You can recursively match patterns against a directory, file or extension with a double asterisk (**):
16 | #foo/**/qux
17 | # This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
18 |
19 | # You can also negate patterns with an exclamation (!).
20 | # For example, you can ignore all files in a docs folder with the file extension .md:
21 | #docs/*.md
22 | # Then explicitly reverse the ignore rule for a single file:
23 | #!docs/README.md
24 |
25 | git_push.sh
26 | appveyor.yml
27 |
28 | src/Mux.Csharp.Sdk.Test/Api/*.cs
29 | src/Mux.Csharp.Sdk.Test/Model/*.cs
30 |
--------------------------------------------------------------------------------
/.openapi-generator/VERSION:
--------------------------------------------------------------------------------
1 | 5.4.0
--------------------------------------------------------------------------------
/.tool-versions:
--------------------------------------------------------------------------------
1 | dotnet-core 6.0.302
2 | java zulu-16.32.15
3 | nodejs 16.5.0
4 | yarn 1.22.22
5 |
--------------------------------------------------------------------------------
/.vscode/launch.json:
--------------------------------------------------------------------------------
1 | {
2 | "version": "0.2.0",
3 | "configurations": [
4 | {
5 | // Use IntelliSense to find out which attributes exist for C# debugging
6 | // Use hover for the description of the existing attributes
7 | // For further information visit https://github.com/OmniSharp/omnisharp-vscode/blob/master/debugger-launchjson.md
8 | "name": ".NET Core Launch (console)",
9 | "type": "coreclr",
10 | "request": "launch",
11 | "preLaunchTask": "build",
12 | // If you have changed target frameworks, make sure to update the program path.
13 | "program": "${workspaceFolder}/src/Mux.Csharp.Sdk.Test/bin/Debug/netcoreapp3.1/Mux.Csharp.Sdk.Test.dll",
14 | "args": [],
15 | "cwd": "${workspaceFolder}/src/Mux.Csharp.Sdk.Test",
16 | // For more information about the 'console' field, see https://aka.ms/VSCode-CS-LaunchJson-Console
17 | "console": "internalConsole",
18 | "stopAtEntry": false
19 | },
20 | {
21 | "name": ".NET Core Attach",
22 | "type": "coreclr",
23 | "request": "attach"
24 | }
25 | ]
26 | }
--------------------------------------------------------------------------------
/.vscode/tasks.json:
--------------------------------------------------------------------------------
1 | {
2 | "version": "2.0.0",
3 | "tasks": [
4 | {
5 | "label": "build",
6 | "command": "dotnet",
7 | "type": "process",
8 | "args": [
9 | "build",
10 | "${workspaceFolder}/src/Mux.Csharp.Sdk.Test/Mux.Csharp.Sdk.Test.csproj",
11 | "/property:GenerateFullPaths=true",
12 | "/consoleloggerparameters:NoSummary"
13 | ],
14 | "problemMatcher": "$msCompile"
15 | },
16 | {
17 | "label": "publish",
18 | "command": "dotnet",
19 | "type": "process",
20 | "args": [
21 | "publish",
22 | "${workspaceFolder}/src/Mux.Csharp.Sdk.Test/Mux.Csharp.Sdk.Test.csproj",
23 | "/property:GenerateFullPaths=true",
24 | "/consoleloggerparameters:NoSummary"
25 | ],
26 | "problemMatcher": "$msCompile"
27 | },
28 | {
29 | "label": "watch",
30 | "command": "dotnet",
31 | "type": "process",
32 | "args": [
33 | "watch",
34 | "run",
35 | "--project",
36 | "${workspaceFolder}/src/Mux.Csharp.Sdk.Test/Mux.Csharp.Sdk.Test.csproj"
37 | ],
38 | "problemMatcher": "$msCompile"
39 | }
40 | ]
41 | }
--------------------------------------------------------------------------------
/CODEOWNERS:
--------------------------------------------------------------------------------
1 | * @muxinc/techops
2 | /CODEOWNERS @muxinc/platform-engineering
3 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2024 Mux, Inc.
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/Mux.Csharp.Sdk.sln:
--------------------------------------------------------------------------------
1 | Microsoft Visual Studio Solution File, Format Version 12.00
2 | # Visual Studio 14
3 | VisualStudioVersion = 14.0.25420.1
4 | MinimumVisualStudioVersion = 10.0.40219.1
5 | Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Mux.Csharp.Sdk", "src\Mux.Csharp.Sdk\Mux.Csharp.Sdk.csproj", "{774F32CB-5292-4985-BAA4-204DFB4F8367}"
6 | EndProject
7 | Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Mux.Csharp.Sdk.Test", "src\Mux.Csharp.Sdk.Test\Mux.Csharp.Sdk.Test.csproj", "{19F1DEBC-DE5E-4517-8062-F000CD499087}"
8 | EndProject
9 | Global
10 | GlobalSection(SolutionConfigurationPlatforms) = preSolution
11 | Debug|Any CPU = Debug|Any CPU
12 | Release|Any CPU = Release|Any CPU
13 | EndGlobalSection
14 | GlobalSection(ProjectConfigurationPlatforms) = postSolution
15 | {774F32CB-5292-4985-BAA4-204DFB4F8367}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
16 | {774F32CB-5292-4985-BAA4-204DFB4F8367}.Debug|Any CPU.Build.0 = Debug|Any CPU
17 | {774F32CB-5292-4985-BAA4-204DFB4F8367}.Release|Any CPU.ActiveCfg = Release|Any CPU
18 | {774F32CB-5292-4985-BAA4-204DFB4F8367}.Release|Any CPU.Build.0 = Release|Any CPU
19 | {19F1DEBC-DE5E-4517-8062-F000CD499087}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
20 | {19F1DEBC-DE5E-4517-8062-F000CD499087}.Debug|Any CPU.Build.0 = Debug|Any CPU
21 | {19F1DEBC-DE5E-4517-8062-F000CD499087}.Release|Any CPU.ActiveCfg = Release|Any CPU
22 | {19F1DEBC-DE5E-4517-8062-F000CD499087}.Release|Any CPU.Build.0 = Release|Any CPU
23 | EndGlobalSection
24 | GlobalSection(SolutionProperties) = preSolution
25 | HideSolutionNode = FALSE
26 | EndGlobalSection
27 | EndGlobal
--------------------------------------------------------------------------------
/docs/AbridgedVideoView.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.AbridgedVideoView
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Id** | **string** | | [optional]
8 | **ViewerOsFamily** | **string** | | [optional]
9 | **ViewerApplicationName** | **string** | | [optional]
10 | **VideoTitle** | **string** | | [optional]
11 | **TotalRowCount** | **long** | | [optional]
12 | **PlayerErrorMessage** | **string** | | [optional]
13 | **PlayerErrorCode** | **string** | | [optional]
14 | **ErrorTypeId** | **int?** | | [optional]
15 | **CountryCode** | **string** | | [optional]
16 | **ViewStart** | **string** | | [optional]
17 | **ViewEnd** | **string** | | [optional]
18 | **ViewerExperienceScore** | **float?** | | [optional]
19 | **WatchTime** | **int?** | | [optional]
20 | **PlaybackFailure** | **bool** | | [optional]
21 |
22 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
23 |
24 |
--------------------------------------------------------------------------------
/docs/AssetErrors.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.AssetErrors
2 | Object that describes any errors that happened when processing this asset.
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **Type** | **string** | The type of error that occurred for this asset. | [optional]
9 | **Messages** | **List<string>** | Error messages with more details. | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/AssetGeneratedSubtitleSettings.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.AssetGeneratedSubtitleSettings
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Name** | **string** | A name for this subtitle track. | [optional]
8 | **Passthrough** | **string** | Arbitrary metadata set for the subtitle track. Max 255 characters. | [optional]
9 | **LanguageCode** | **string** | The language to generate subtitles in. | [optional] [default to LanguageCodeEnum.En]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/AssetMaster.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.AssetMaster
2 | An object containing the current status of Master Access and the link to the Master MP4 file when ready. This object does not exist if `master_access` is set to `none` and when the temporary URL expires.
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **Status** | **string** | | [optional]
9 | **Url** | **string** | The temporary URL to the master version of the video, as an MP4 file. This URL will expire after 24 hours. | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/AssetMetadata.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.AssetMetadata
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Title** | **string** | The video title. Max 512 code points. | [optional]
8 | **CreatorId** | **string** | This is an identifier you provide to keep track of the creator of the video. Max 128 code points. | [optional]
9 | **ExternalId** | **string** | This is an identifier you provide to link the video to your own data. Max 128 code points. | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/AssetRecordingTimes.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.AssetRecordingTimes
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **StartedAt** | **DateTime** | The time at which the recording for the live stream started. The time value is Unix epoch time represented in ISO 8601 format. | [optional]
8 | **Duration** | **double** | The duration of the live stream recorded. The time value is in seconds. | [optional]
9 | **Type** | **string** | The type of media represented by the recording session, either `content` for normal stream content or `slate` for slate media inserted during stream interruptions. | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/AssetResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.AssetResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**Asset**](Asset.md) | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/AssetStaticRenditions.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.AssetStaticRenditions
2 | 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.
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **Status** | **string** | Indicates the status of downloadable MP4 versions of this asset. This field is only valid when `mp4_support` is enabled | [optional] [default to StatusEnum.Disabled]
9 | **Files** | [**List<StaticRendition>**](StaticRendition.md) | Array of file objects. | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/BreakdownValue.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.BreakdownValue
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Views** | **long** | | [optional]
8 | **Value** | **double** | | [optional]
9 | **TotalWatchTime** | **long?** | | [optional]
10 | **TotalPlayingTime** | **long?** | | [optional]
11 | **NegativeImpact** | **int** | | [optional]
12 | **Field** | **string** | | [optional]
13 |
14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15 |
16 |
--------------------------------------------------------------------------------
/docs/CreatePlaybackIDRequest.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.CreatePlaybackIDRequest
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Policy** | **PlaybackPolicy** | | [optional]
8 | **DrmConfigurationId** | **string** | The DRM configuration used by this playback ID. Must only be set when `policy` is set to `drm`. | [optional]
9 |
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 |
12 |
--------------------------------------------------------------------------------
/docs/CreatePlaybackIDResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.CreatePlaybackIDResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**PlaybackID**](PlaybackID.md) | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/CreatePlaybackRestrictionRequest.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.CreatePlaybackRestrictionRequest
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Referrer** | [**ReferrerDomainRestriction**](ReferrerDomainRestriction.md) | | [optional]
8 | **UserAgent** | [**UserAgentRestrictionRequest**](UserAgentRestrictionRequest.md) | | [optional]
9 |
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 |
12 |
--------------------------------------------------------------------------------
/docs/CreateSimulcastTargetRequest.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.CreateSimulcastTargetRequest
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Passthrough** | **string** | Arbitrary user-supplied metadata set by you when creating a simulcast target. | [optional]
8 | **StreamKey** | **string** | Stream Key represents a stream identifier on the third party live streaming service to send the parent live stream to. Only used for RTMP(s) simulcast destinations. | [optional]
9 | **Url** | **string** | The RTMP(s) or SRT endpoint for a simulcast destination. * For RTMP(s) destinations, this should include the application name for the third party live streaming service, for example: `rtmp://live.example.com/app`. * For SRT destinations, this should be a fully formed SRT connection string, for example: `srt://srt-live.example.com:1234?streamid={stream_key}&passphrase={srt_passphrase}`. Note: SRT simulcast targets can only be used when an source is connected over SRT. | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/CreateStaticRenditionRequest.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.CreateStaticRenditionRequest
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Resolution** | **string** | | [optional]
8 | **Passthrough** | **string** | Arbitrary user-supplied metadata set for the static rendition. Max 255 characters. | [optional]
9 |
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 |
12 |
--------------------------------------------------------------------------------
/docs/CreateStaticRenditionResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.CreateStaticRenditionResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**StaticRendition**](StaticRendition.md) | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/CreateTrackRequest.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.CreateTrackRequest
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Url** | **string** | The URL of the file that Mux should download and use. * 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. |
8 | **Type** | **string** | |
9 | **TextType** | **string** | |
10 | **LanguageCode** | **string** | The language code value must be a valid BCP 47 specification compliant value. For example, en for English or en-US for the US version of English. |
11 | **Name** | **string** | The name of the track containing a human-readable description. This value must be unique within each group of `text` or `audio` track types. The HLS manifest will associate the `text` or `audio` track with this value. For example, set the value to \"English\" for subtitles text track with `language_code` as en-US. If this parameter is not included, Mux will auto-populate a value based on the `language_code` value. | [optional]
12 | **ClosedCaptions** | **bool** | Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). | [optional]
13 | **Passthrough** | **string** | Arbitrary user-supplied metadata set for the track either when creating the asset or track. | [optional]
14 |
15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
16 |
17 |
--------------------------------------------------------------------------------
/docs/CreateTrackResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.CreateTrackResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**Track**](Track.md) | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/CreateTranscriptionVocabularyRequest.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.CreateTranscriptionVocabularyRequest
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Name** | **string** | The user-supplied name of the Transcription Vocabulary. | [optional]
8 | **Phrases** | **List<string>** | Phrases, individual words, or proper names to include in the Transcription Vocabulary. When the Transcription Vocabulary is attached to a live stream's `generated_subtitles`, the probability of successful speech recognition for these words or phrases is boosted. |
9 | **Passthrough** | **string** | Arbitrary user-supplied metadata set for the Transcription Vocabulary. Max 255 characters. | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/CreateUploadRequest.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.CreateUploadRequest
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Timeout** | **int** | 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]
8 | **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]
9 | **NewAssetSettings** | [**CreateAssetRequest**](CreateAssetRequest.md) | | [optional]
10 | **Test** | **bool** | Indicates if this is a test Direct Upload, in which case the Asset that gets created will be a `test` Asset. | [optional]
11 |
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 |
14 |
--------------------------------------------------------------------------------
/docs/CreateWebInputRequest.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.CreateWebInputRequest
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Id** | **string** | Unique identifier for the Web Input. | [optional]
8 | **CreatedAt** | **string** | Time the Web Input was created, defined as a Unix timestamp (seconds since epoch). | [optional]
9 | **Url** | **string** | The URL for the Web Input to load. | [optional]
10 | **AutoLaunch** | **bool** | When set to `true` the Web Input will automatically launch and start streaming immediately after creation | [optional]
11 | **LiveStreamId** | **string** | The Live Stream ID to broadcast this Web Input to | [optional]
12 | **Status** | **string** | | [optional]
13 | **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]
14 | **Resolution** | **string** | The resolution of the viewport of the Web Input's browser instance. Defaults to 1920x1080 if not set. | [optional] [default to ResolutionEnum._1920x1080]
15 | **Timeout** | **int** | The number of seconds that the Web Input should stream for before automatically shutting down. | [optional] [default to 3600]
16 |
17 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
18 |
19 |
--------------------------------------------------------------------------------
/docs/DRMConfiguration.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.DRMConfiguration
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Id** | **string** | Unique identifier for the DRM Configuration. Max 255 characters. | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/DRMConfigurationResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.DRMConfigurationResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**DRMConfiguration**](DRMConfiguration.md) | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/DeliveryReport.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.DeliveryReport
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **LiveStreamId** | **string** | Unique identifier for the live stream that created the asset. | [optional]
8 | **AssetId** | **string** | Unique identifier for the asset. | [optional]
9 | **Passthrough** | **string** | The `passthrough` value for the asset. | [optional]
10 | **CreatedAt** | **string** | Time at which the asset was created. Measured in seconds since the Unix epoch. | [optional]
11 | **DeletedAt** | **string** | If exists, time at which the asset was deleted. Measured in seconds since the Unix epoch. | [optional]
12 | **AssetState** | **string** | The state of the asset. | [optional]
13 | **AssetDuration** | **double** | The duration of the asset in seconds. | [optional]
14 | **AssetResolutionTier** | **string** | The resolution tier that the asset was ingested at, affecting billing for ingest & storage | [optional]
15 | **AssetEncodingTier** | **string** | This field is deprecated. Please use `asset_video_quality` instead. The encoding tier that the asset was ingested at. [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels) | [optional]
16 | **AssetVideoQuality** | **string** | The video quality that the asset was ingested at. This field replaces `asset_encoding_tier`. [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels) | [optional]
17 | **DeliveredSeconds** | **double** | Total number of delivered seconds during this time window. | [optional]
18 | **DeliveredSecondsByResolution** | [**DeliveryReportDeliveredSecondsByResolution**](DeliveryReportDeliveredSecondsByResolution.md) | | [optional]
19 |
20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
21 |
22 |
--------------------------------------------------------------------------------
/docs/DeliveryReportDeliveredSecondsByResolution.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.DeliveryReportDeliveredSecondsByResolution
2 | Seconds delivered broken into resolution tiers. Each tier will only be displayed if there was content delivered in the tier.
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **Tier2160p** | **double** | Total number of delivered seconds during this time window that had a resolution larger than the 1440p tier (over 4,194,304 pixels total). | [optional]
9 | **Tier1440p** | **double** | Total number of delivered seconds during this time window that had a resolution larger than the 1080p tier but less than or equal to the 2160p tier (over 2,073,600 and <= 4,194,304 pixels total). | [optional]
10 | **Tier1080p** | **double** | Total number of delivered seconds during this time window that had a resolution larger than the 720p tier but less than or equal to the 1440p tier (over 921,600 and <= 2,073,600 pixels total). | [optional]
11 | **Tier720p** | **double** | Total number of delivered seconds during this time window that had a resolution within the 720p tier (up to 921,600 pixels total, based on typical 1280x720). | [optional]
12 | **TierAudioOnly** | **double** | Total number of delivered seconds during this time window that had a resolution of audio only. | [optional]
13 |
14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15 |
16 |
--------------------------------------------------------------------------------
/docs/DimensionValue.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.DimensionValue
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Value** | **string** | | [optional]
8 | **TotalCount** | **long** | | [optional]
9 |
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 |
12 |
--------------------------------------------------------------------------------
/docs/DisableLiveStreamResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.DisableLiveStreamResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | **Object** | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/EnableLiveStreamResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.EnableLiveStreamResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | **Object** | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/Error.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.Error
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Id** | **long** | A unique identifier for this error. | [optional]
8 | **Percentage** | **double** | The percentage of views that experienced this error. | [optional]
9 | **Notes** | **string** | Notes that are attached to this error. | [optional]
10 | **Message** | **string** | The error message. | [optional]
11 | **LastSeen** | **string** | The last time this error was seen (ISO 8601 timestamp). | [optional]
12 | **Description** | **string** | Description of the error. | [optional]
13 | **Count** | **long** | The total number of views that experienced this error. | [optional]
14 | **Code** | **long?** | The error code | [optional]
15 | **PlayerErrorCode** | **string** | The string version of the error code | [optional]
16 |
17 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
18 |
19 |
--------------------------------------------------------------------------------
/docs/ExportDate.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.ExportDate
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **_ExportDate** | **DateTime** | | [optional]
8 | **Files** | [**List<ExportFile>**](ExportFile.md) | | [optional]
9 |
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 |
12 |
--------------------------------------------------------------------------------
/docs/ExportFile.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.ExportFile
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **_Version** | **int** | | [optional]
8 | **Type** | **string** | | [optional]
9 | **Path** | **string** | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/FilterValue.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.FilterValue
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Value** | **string** | | [optional]
8 | **TotalCount** | **long** | | [optional]
9 |
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 |
12 |
--------------------------------------------------------------------------------
/docs/GenerateTrackSubtitlesRequest.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.GenerateTrackSubtitlesRequest
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **GeneratedSubtitles** | [**List<AssetGeneratedSubtitleSettings>**](AssetGeneratedSubtitleSettings.md) | Generate subtitle tracks using automatic speech recognition with this configuration. | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/GenerateTrackSubtitlesResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.GenerateTrackSubtitlesResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**List<Track>**](Track.md) | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/GetAssetInputInfoResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.GetAssetInputInfoResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**List<InputInfo>**](InputInfo.md) | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/GetAssetOrLiveStreamIdResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.GetAssetOrLiveStreamIdResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**GetAssetOrLiveStreamIdResponseData**](GetAssetOrLiveStreamIdResponseData.md) | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/GetAssetOrLiveStreamIdResponseData.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.GetAssetOrLiveStreamIdResponseData
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Id** | **string** | The Playback ID used to retrieve the corresponding asset or the live stream ID | [optional]
8 | **Policy** | **PlaybackPolicy** | | [optional]
9 | **Object** | [**GetAssetOrLiveStreamIdResponseDataObject**](GetAssetOrLiveStreamIdResponseDataObject.md) | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/GetAssetOrLiveStreamIdResponseDataObject.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.GetAssetOrLiveStreamIdResponseDataObject
2 | Describes the Asset or LiveStream object associated with the playback ID.
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **Id** | **string** | The identifier of the object. | [optional]
9 | **Type** | **string** | Identifies the object type associated with the playback ID. | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/GetAssetPlaybackIDResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.GetAssetPlaybackIDResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**PlaybackID**](PlaybackID.md) | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/GetLiveStreamPlaybackIDResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.GetLiveStreamPlaybackIDResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**PlaybackID**](PlaybackID.md) | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/GetMetricTimeseriesDataResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.GetMetricTimeseriesDataResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | **List<List<string>>** | | [optional]
8 | **TotalRowCount** | **long** | | [optional]
9 | **Timeframe** | **List<long>** | | [optional]
10 | **Meta** | [**ListBreakdownValuesResponseMeta**](ListBreakdownValuesResponseMeta.md) | | [optional]
11 |
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 |
14 |
--------------------------------------------------------------------------------
/docs/GetMonitoringBreakdownResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.GetMonitoringBreakdownResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**List<MonitoringBreakdownValue>**](MonitoringBreakdownValue.md) | | [optional]
8 | **TotalRowCount** | **long?** | | [optional]
9 | **Timeframe** | **List<long>** | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/GetMonitoringBreakdownTimeseriesResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.GetMonitoringBreakdownTimeseriesResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**List<MonitoringBreakdownTimeseriesValues>**](MonitoringBreakdownTimeseriesValues.md) | | [optional]
8 | **TotalRowCount** | **long?** | | [optional]
9 | **Timeframe** | **List<long>** | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/GetMonitoringHistogramTimeseriesResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.GetMonitoringHistogramTimeseriesResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Meta** | [**GetMonitoringHistogramTimeseriesResponseMeta**](GetMonitoringHistogramTimeseriesResponseMeta.md) | | [optional]
8 | **Data** | [**List<MonitoringHistogramTimeseriesDatapoint>**](MonitoringHistogramTimeseriesDatapoint.md) | | [optional]
9 | **TotalRowCount** | **long?** | | [optional]
10 | **Timeframe** | **List<long>** | | [optional]
11 |
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 |
14 |
--------------------------------------------------------------------------------
/docs/GetMonitoringHistogramTimeseriesResponseMeta.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.GetMonitoringHistogramTimeseriesResponseMeta
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **BucketUnit** | **string** | | [optional]
8 | **Buckets** | [**List<MonitoringHistogramTimeseriesBucket>**](MonitoringHistogramTimeseriesBucket.md) | | [optional]
9 |
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 |
12 |
--------------------------------------------------------------------------------
/docs/GetMonitoringTimeseriesResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.GetMonitoringTimeseriesResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**List<MonitoringTimeseriesDatapoint>**](MonitoringTimeseriesDatapoint.md) | | [optional]
8 | **TotalRowCount** | **long?** | | [optional]
9 | **Timeframe** | **List<long>** | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/GetOverallValuesResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.GetOverallValuesResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**OverallValues**](OverallValues.md) | | [optional]
8 | **TotalRowCount** | **long?** | | [optional]
9 | **Timeframe** | **List<long>** | | [optional]
10 | **Meta** | [**ListBreakdownValuesResponseMeta**](ListBreakdownValuesResponseMeta.md) | | [optional]
11 |
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 |
14 |
--------------------------------------------------------------------------------
/docs/GetRealTimeBreakdownResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.GetRealTimeBreakdownResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**List<RealTimeBreakdownValue>**](RealTimeBreakdownValue.md) | | [optional]
8 | **TotalRowCount** | **long?** | | [optional]
9 | **Timeframe** | **List<long>** | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/GetRealTimeHistogramTimeseriesResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.GetRealTimeHistogramTimeseriesResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Meta** | [**GetRealTimeHistogramTimeseriesResponseMeta**](GetRealTimeHistogramTimeseriesResponseMeta.md) | | [optional]
8 | **Data** | [**List<RealTimeHistogramTimeseriesDatapoint>**](RealTimeHistogramTimeseriesDatapoint.md) | | [optional]
9 | **TotalRowCount** | **long?** | | [optional]
10 | **Timeframe** | **List<long>** | | [optional]
11 |
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 |
14 |
--------------------------------------------------------------------------------
/docs/GetRealTimeHistogramTimeseriesResponseMeta.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.GetRealTimeHistogramTimeseriesResponseMeta
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **BucketUnit** | **string** | | [optional]
8 | **Buckets** | [**List<RealTimeHistogramTimeseriesBucket>**](RealTimeHistogramTimeseriesBucket.md) | | [optional]
9 |
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 |
12 |
--------------------------------------------------------------------------------
/docs/GetRealTimeTimeseriesResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.GetRealTimeTimeseriesResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**List<RealTimeTimeseriesDatapoint>**](RealTimeTimeseriesDatapoint.md) | | [optional]
8 | **TotalRowCount** | **long?** | | [optional]
9 | **Timeframe** | **List<long>** | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/Incident.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.Incident
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Threshold** | **double** | | [optional]
8 | **Status** | **string** | | [optional]
9 | **StartedAt** | **string** | | [optional]
10 | **Severity** | **string** | | [optional]
11 | **SampleSizeUnit** | **string** | | [optional]
12 | **SampleSize** | **long** | | [optional]
13 | **ResolvedAt** | **string** | | [optional]
14 | **Notifications** | [**List<IncidentNotification>**](IncidentNotification.md) | | [optional]
15 | **NotificationRules** | [**List<IncidentNotificationRule>**](IncidentNotificationRule.md) | | [optional]
16 | **Measurement** | **string** | | [optional]
17 | **MeasuredValueOnClose** | **double?** | | [optional]
18 | **MeasuredValue** | **double?** | | [optional]
19 | **IncidentKey** | **string** | | [optional]
20 | **Impact** | **string** | | [optional]
21 | **Id** | **string** | | [optional]
22 | **ErrorDescription** | **string** | | [optional]
23 | **Description** | **string** | | [optional]
24 | **Breakdowns** | [**List<IncidentBreakdown>**](IncidentBreakdown.md) | | [optional]
25 | **AffectedViewsPerHourOnOpen** | **long** | | [optional]
26 | **AffectedViewsPerHour** | **long** | | [optional]
27 | **AffectedViews** | **long** | | [optional]
28 |
29 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
30 |
31 |
--------------------------------------------------------------------------------
/docs/IncidentBreakdown.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.IncidentBreakdown
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Value** | **string** | | [optional]
8 | **Name** | **string** | | [optional]
9 | **Id** | **string** | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/IncidentNotification.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.IncidentNotification
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **QueuedAt** | **string** | | [optional]
8 | **Id** | **long** | | [optional]
9 | **AttemptedAt** | **string** | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/IncidentNotificationRule.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.IncidentNotificationRule
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Status** | **string** | | [optional]
8 | **Rules** | [**List<NotificationRule>**](NotificationRule.md) | | [optional]
9 | **PropertyId** | **string** | | [optional]
10 | **Id** | **string** | | [optional]
11 | **Action** | **string** | | [optional]
12 |
13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14 |
15 |
--------------------------------------------------------------------------------
/docs/IncidentResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.IncidentResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**Incident**](Incident.md) | | [optional]
8 | **TotalRowCount** | **long?** | | [optional]
9 | **Timeframe** | **List<long>** | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/InputFile.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.InputFile
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **ContainerFormat** | **string** | | [optional]
8 | **Tracks** | [**List<InputTrack>**](InputTrack.md) | | [optional]
9 |
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 |
12 |
--------------------------------------------------------------------------------
/docs/InputInfo.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.InputInfo
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Settings** | [**InputSettings**](InputSettings.md) | | [optional]
8 | **File** | [**InputFile**](InputFile.md) | | [optional]
9 |
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 |
12 |
--------------------------------------------------------------------------------
/docs/InputSettingsOverlaySettings.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.InputSettingsOverlaySettings
2 | An object that describes how the image file referenced in URL should be placed over the video (i.e. watermarking). Ensure that the URL is active and persists the entire lifespan of the video object.
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **VerticalAlign** | **string** | Where the vertical positioning of the overlay/watermark should begin from. Defaults to `\"top\"` | [optional]
9 | **VerticalMargin** | **string** | The distance from the vertical_align starting point and the image's closest edge. Can be expressed as a percent (\"10%\") or as a pixel value (\"100px\"). Negative values will move the overlay offscreen. In the case of 'middle', a positive value will shift the overlay towards the bottom and and a negative value will shift it towards the top. | [optional]
10 | **HorizontalAlign** | **string** | Where the horizontal positioning of the overlay/watermark should begin from. | [optional]
11 | **HorizontalMargin** | **string** | The distance from the horizontal_align starting point and the image's closest edge. Can be expressed as a percent (\"10%\") or as a pixel value (\"100px\"). Negative values will move the overlay offscreen. In the case of 'center', a positive value will shift the image towards the right and and a negative value will shift it towards the left. | [optional]
12 | **Width** | **string** | How wide the overlay should appear. Can be expressed as a percent (\"10%\") or as a pixel value (\"100px\"). If both width and height are left blank the width will be the true pixels of the image, applied as if the video has been scaled to fit a 1920x1080 frame. If height is supplied with no width, the width will scale proportionally to the height. | [optional]
13 | **Height** | **string** | How tall the overlay should appear. Can be expressed as a percent (\"10%\") or as a pixel value (\"100px\"). If both width and height are left blank the height will be the true pixels of the image, applied as if the video has been scaled to fit a 1920x1080 frame. If width is supplied with no height, the height will scale proportionally to the width. | [optional]
14 | **Opacity** | **string** | How opaque the overlay should appear, expressed as a percent. (Default 100%) | [optional]
15 |
16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
17 |
18 |
--------------------------------------------------------------------------------
/docs/InputTrack.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.InputTrack
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Type** | **string** | | [optional]
8 | **Duration** | **double** | | [optional]
9 | **Encoding** | **string** | | [optional]
10 | **Width** | **long** | | [optional]
11 | **Height** | **long** | | [optional]
12 | **FrameRate** | **double** | | [optional]
13 | **SampleRate** | **long** | | [optional]
14 | **SampleSize** | **long** | | [optional]
15 | **Channels** | **long** | | [optional]
16 |
17 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
18 |
19 |
--------------------------------------------------------------------------------
/docs/Insight.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.Insight
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **TotalWatchTime** | **long?** | | [optional]
8 | **TotalPlayingTime** | **long?** | | [optional]
9 | **TotalViews** | **long** | | [optional]
10 | **NegativeImpactScore** | **float** | | [optional]
11 | **Metric** | **double** | | [optional]
12 | **FilterValue** | **string** | | [optional]
13 | **FilterColumn** | **string** | | [optional]
14 |
15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
16 |
17 |
--------------------------------------------------------------------------------
/docs/LaunchWebInputResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.LaunchWebInputResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | **Object** | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/ListAllMetricValuesResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.ListAllMetricValuesResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**List<Score>**](Score.md) | | [optional]
8 | **TotalRowCount** | **long?** | | [optional]
9 | **Timeframe** | **List<long>** | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/ListAssetsResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.ListAssetsResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**List<Asset>**](Asset.md) | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/ListBreakdownValuesResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.ListBreakdownValuesResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**List<BreakdownValue>**](BreakdownValue.md) | | [optional]
8 | **TotalRowCount** | **long** | | [optional]
9 | **Timeframe** | **List<long>** | | [optional]
10 | **Meta** | [**ListBreakdownValuesResponseMeta**](ListBreakdownValuesResponseMeta.md) | | [optional]
11 |
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 |
14 |
--------------------------------------------------------------------------------
/docs/ListBreakdownValuesResponseMeta.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.ListBreakdownValuesResponseMeta
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Granularity** | **string** | | [optional]
8 | **Aggregation** | **string** | | [optional]
9 |
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 |
12 |
--------------------------------------------------------------------------------
/docs/ListDRMConfigurationsResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.ListDRMConfigurationsResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**List<DRMConfiguration>**](DRMConfiguration.md) | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/ListDeliveryUsageResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.ListDeliveryUsageResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**List<DeliveryReport>**](DeliveryReport.md) | | [optional]
8 | **TotalRowCount** | **long** | | [optional]
9 | **Timeframe** | **List<long>** | | [optional]
10 | **Limit** | **long** | Number of assets returned in this response. Default value is 100. | [optional]
11 |
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 |
14 |
--------------------------------------------------------------------------------
/docs/ListDimensionValuesResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.ListDimensionValuesResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**List<DimensionValue>**](DimensionValue.md) | | [optional]
8 | **TotalRowCount** | **long** | | [optional]
9 | **Timeframe** | **List<long>** | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/ListDimensionsResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.ListDimensionsResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**ListFiltersResponseData**](ListFiltersResponseData.md) | | [optional]
8 | **TotalRowCount** | **long?** | | [optional]
9 | **Timeframe** | **List<long>** | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/ListErrorsResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.ListErrorsResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**List<Error>**](Error.md) | | [optional]
8 | **TotalRowCount** | **long?** | | [optional]
9 | **Timeframe** | **List<long>** | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/ListExportsResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.ListExportsResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | **List<string>** | | [optional]
8 | **TotalRowCount** | **long?** | | [optional]
9 | **Timeframe** | **List<long>** | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/ListFilterValuesResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.ListFilterValuesResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**List<FilterValue>**](FilterValue.md) | | [optional]
8 | **TotalRowCount** | **long** | | [optional]
9 | **Timeframe** | **List<long>** | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/ListFiltersResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.ListFiltersResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**ListFiltersResponseData**](ListFiltersResponseData.md) | | [optional]
8 | **TotalRowCount** | **long?** | | [optional]
9 | **Timeframe** | **List<long>** | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/ListFiltersResponseData.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.ListFiltersResponseData
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Basic** | **List<string>** | | [optional]
8 | **Advanced** | **List<string>** | | [optional]
9 |
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 |
12 |
--------------------------------------------------------------------------------
/docs/ListIncidentsResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.ListIncidentsResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**List<Incident>**](Incident.md) | | [optional]
8 | **TotalRowCount** | **long?** | | [optional]
9 | **Timeframe** | **List<long>** | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/ListInsightsResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.ListInsightsResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**List<Insight>**](Insight.md) | | [optional]
8 | **TotalRowCount** | **long** | | [optional]
9 | **Timeframe** | **List<long>** | | [optional]
10 | **Meta** | [**ListBreakdownValuesResponseMeta**](ListBreakdownValuesResponseMeta.md) | | [optional]
11 |
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 |
14 |
--------------------------------------------------------------------------------
/docs/ListLiveStreamsResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.ListLiveStreamsResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**List<LiveStream>**](LiveStream.md) | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/ListMonitoringDimensionsResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.ListMonitoringDimensionsResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**List<ListMonitoringDimensionsResponseData>**](ListMonitoringDimensionsResponseData.md) | | [optional]
8 | **TotalRowCount** | **long?** | | [optional]
9 | **Timeframe** | **List<long>** | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/ListMonitoringDimensionsResponseData.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.ListMonitoringDimensionsResponseData
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Name** | **string** | | [optional]
8 | **DisplayName** | **string** | | [optional]
9 |
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 |
12 |
--------------------------------------------------------------------------------
/docs/ListMonitoringMetricsResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.ListMonitoringMetricsResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**List<ListMonitoringDimensionsResponseData>**](ListMonitoringDimensionsResponseData.md) | | [optional]
8 | **TotalRowCount** | **long?** | | [optional]
9 | **Timeframe** | **List<long>** | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/ListPlaybackRestrictionsResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.ListPlaybackRestrictionsResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**List<PlaybackRestriction>**](PlaybackRestriction.md) | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/ListRealTimeDimensionsResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.ListRealTimeDimensionsResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**List<ListMonitoringDimensionsResponseData>**](ListMonitoringDimensionsResponseData.md) | | [optional]
8 | **TotalRowCount** | **long?** | | [optional]
9 | **Timeframe** | **List<long>** | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/ListRealTimeMetricsResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.ListRealTimeMetricsResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**List<ListMonitoringDimensionsResponseData>**](ListMonitoringDimensionsResponseData.md) | | [optional]
8 | **TotalRowCount** | **long?** | | [optional]
9 | **Timeframe** | **List<long>** | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/ListRelatedIncidentsResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.ListRelatedIncidentsResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**List<Incident>**](Incident.md) | | [optional]
8 | **TotalRowCount** | **long?** | | [optional]
9 | **Timeframe** | **List<long>** | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/ListSigningKeysResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.ListSigningKeysResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**List<SigningKey>**](SigningKey.md) | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/ListTranscriptionVocabulariesResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.ListTranscriptionVocabulariesResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**List<TranscriptionVocabulary>**](TranscriptionVocabulary.md) | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/ListUploadsResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.ListUploadsResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**List<Upload>**](Upload.md) | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/ListVideoViewExportsResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.ListVideoViewExportsResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**List<ExportDate>**](ExportDate.md) | | [optional]
8 | **TotalRowCount** | **int?** | | [optional]
9 | **Timeframe** | **List<int>** | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/ListVideoViewsResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.ListVideoViewsResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**List<AbridgedVideoView>**](AbridgedVideoView.md) | | [optional]
8 | **TotalRowCount** | **long?** | | [optional]
9 | **Timeframe** | **List<long>** | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/ListWebInputsResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.ListWebInputsResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**List<WebInput>**](WebInput.md) | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/LiveStreamEmbeddedSubtitleSettings.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.LiveStreamEmbeddedSubtitleSettings
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Name** | **string** | A name for this live stream closed caption track. | [optional]
8 | **Passthrough** | **string** | Arbitrary user-supplied metadata set for the live stream closed caption track. Max 255 characters. | [optional]
9 | **LanguageCode** | **string** | The language of the closed caption stream. Value must be BCP 47 compliant. | [optional] [default to "en"]
10 | **LanguageChannel** | **string** | CEA-608 caption channel to read data from. | [optional] [default to LanguageChannelEnum.Cc1]
11 |
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 |
14 |
--------------------------------------------------------------------------------
/docs/LiveStreamGeneratedSubtitleSettings.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.LiveStreamGeneratedSubtitleSettings
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Name** | **string** | A name for this live stream subtitle track. | [optional]
8 | **Passthrough** | **string** | Arbitrary metadata set for the live stream subtitle track. Max 255 characters. | [optional]
9 | **LanguageCode** | **string** | The language to generate subtitles in. | [optional] [default to LanguageCodeEnum.En]
10 | **TranscriptionVocabularyIds** | **List<string>** | Unique identifiers for existing Transcription Vocabularies to use while generating subtitles for the live stream. If the Transcription Vocabularies provided collectively have more than 1000 phrases, only the first 1000 phrases will be included. | [optional]
11 |
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 |
14 |
--------------------------------------------------------------------------------
/docs/LiveStreamResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.LiveStreamResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**LiveStream**](LiveStream.md) | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/LiveStreamStatus.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.LiveStreamStatus
2 | `idle` indicates that there is no active broadcast. `active` indicates that there is an active broadcast and `disabled` status indicates that no future RTMP streams can be published.
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/Metric.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.Metric
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Value** | **double?** | | [optional]
8 | **Type** | **string** | | [optional]
9 | **Name** | **string** | | [optional]
10 | **_Metric** | **string** | | [optional]
11 | **Measurement** | **string** | | [optional]
12 |
13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14 |
15 |
--------------------------------------------------------------------------------
/docs/MonitoringBreakdownTimeseriesDatapoint.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.MonitoringBreakdownTimeseriesDatapoint
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Value** | **string** | | [optional]
8 | **MetricValue** | **double?** | | [optional]
9 | **ConcurrentViewers** | **long** | | [optional]
10 | **StartingUpViewers** | **long** | | [optional]
11 |
12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13 |
14 |
--------------------------------------------------------------------------------
/docs/MonitoringBreakdownTimeseriesValues.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.MonitoringBreakdownTimeseriesValues
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Values** | [**List<MonitoringBreakdownTimeseriesDatapoint>**](MonitoringBreakdownTimeseriesDatapoint.md) | | [optional]
8 | **Date** | **string** | | [optional]
9 |
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 |
12 |
--------------------------------------------------------------------------------
/docs/MonitoringBreakdownValue.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.MonitoringBreakdownValue
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Value** | **string** | | [optional]
8 | **NegativeImpact** | **long** | | [optional]
9 | **MetricValue** | **double?** | | [optional]
10 | **DisplayValue** | **string** | | [optional]
11 | **ConcurrentViewers** | **long** | | [optional]
12 | **StartingUpViewers** | **long** | | [optional]
13 |
14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15 |
16 |
--------------------------------------------------------------------------------
/docs/MonitoringHistogramTimeseriesBucket.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.MonitoringHistogramTimeseriesBucket
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Start** | **long** | | [optional]
8 | **End** | **long?** | | [optional]
9 |
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 |
12 |
--------------------------------------------------------------------------------
/docs/MonitoringHistogramTimeseriesBucketValues.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.MonitoringHistogramTimeseriesBucketValues
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Percentage** | **double** | | [optional]
8 | **Count** | **long** | | [optional]
9 |
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 |
12 |
--------------------------------------------------------------------------------
/docs/MonitoringHistogramTimeseriesDatapoint.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.MonitoringHistogramTimeseriesDatapoint
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Timestamp** | **string** | | [optional]
8 | **Sum** | **long** | | [optional]
9 | **P95** | **double?** | | [optional]
10 | **Median** | **double?** | | [optional]
11 | **MaxPercentage** | **double** | | [optional]
12 | **BucketValues** | [**List<MonitoringHistogramTimeseriesBucketValues>**](MonitoringHistogramTimeseriesBucketValues.md) | | [optional]
13 | **Average** | **double?** | | [optional]
14 |
15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
16 |
17 |
--------------------------------------------------------------------------------
/docs/MonitoringTimeseriesDatapoint.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.MonitoringTimeseriesDatapoint
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Value** | **double?** | | [optional]
8 | **Date** | **string** | | [optional]
9 | **ConcurrentViewers** | **long** | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/NotificationRule.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.NotificationRule
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Value** | **string** | | [optional]
8 | **Name** | **string** | | [optional]
9 | **Id** | **string** | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/OverallValues.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.OverallValues
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Value** | **double** | | [optional]
8 | **TotalWatchTime** | **long?** | | [optional]
9 | **TotalViews** | **long** | | [optional]
10 | **TotalPlayingTime** | **long?** | | [optional]
11 | **GlobalValue** | **double?** | | [optional]
12 |
13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14 |
15 |
--------------------------------------------------------------------------------
/docs/PlaybackID.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.PlaybackID
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Id** | **string** | Unique identifier for the PlaybackID | [optional]
8 | **Policy** | **PlaybackPolicy** | | [optional]
9 | **DrmConfigurationId** | **string** | The DRM configuration used by this playback ID. Must only be set when `policy` is set to `drm`. | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/PlaybackPolicy.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.PlaybackPolicy
2 | * `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. * `drm` playback IDs are protected with DRM technologies. [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/PlaybackRestriction.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.PlaybackRestriction
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Id** | **string** | Unique identifier for the Playback Restriction. Max 255 characters. | [optional]
8 | **CreatedAt** | **string** | Time the Playback Restriction was created, defined as a Unix timestamp (seconds since epoch). | [optional]
9 | **UpdatedAt** | **string** | Time the Playback Restriction was last updated, defined as a Unix timestamp (seconds since epoch). | [optional]
10 | **Referrer** | [**ReferrerDomainRestriction**](ReferrerDomainRestriction.md) | | [optional]
11 | **UserAgent** | [**UserAgentRestrictionSettings**](UserAgentRestrictionSettings.md) | | [optional]
12 |
13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14 |
15 |
--------------------------------------------------------------------------------
/docs/PlaybackRestrictionResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.PlaybackRestrictionResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**PlaybackRestriction**](PlaybackRestriction.md) | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/RealTimeBreakdownValue.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.RealTimeBreakdownValue
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Value** | **string** | | [optional]
8 | **NegativeImpact** | **long** | | [optional]
9 | **MetricValue** | **double?** | | [optional]
10 | **DisplayValue** | **string** | | [optional]
11 | **ConcurrentViewers** | **long** | | [optional]
12 | **StartingUpViewers** | **long** | | [optional]
13 |
14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15 |
16 |
--------------------------------------------------------------------------------
/docs/RealTimeHistogramTimeseriesBucket.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.RealTimeHistogramTimeseriesBucket
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Start** | **long** | | [optional]
8 | **End** | **long?** | | [optional]
9 |
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 |
12 |
--------------------------------------------------------------------------------
/docs/RealTimeHistogramTimeseriesBucketValues.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.RealTimeHistogramTimeseriesBucketValues
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Percentage** | **double** | | [optional]
8 | **Count** | **long** | | [optional]
9 |
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 |
12 |
--------------------------------------------------------------------------------
/docs/RealTimeHistogramTimeseriesDatapoint.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.RealTimeHistogramTimeseriesDatapoint
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Timestamp** | **string** | | [optional]
8 | **Sum** | **long** | | [optional]
9 | **P95** | **double?** | | [optional]
10 | **Median** | **double?** | | [optional]
11 | **MaxPercentage** | **double** | | [optional]
12 | **BucketValues** | [**List<RealTimeHistogramTimeseriesBucketValues>**](RealTimeHistogramTimeseriesBucketValues.md) | | [optional]
13 | **Average** | **double?** | | [optional]
14 |
15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
16 |
17 |
--------------------------------------------------------------------------------
/docs/RealTimeTimeseriesDatapoint.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.RealTimeTimeseriesDatapoint
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Value** | **double?** | | [optional]
8 | **Date** | **string** | | [optional]
9 | **ConcurrentViewers** | **long** | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/ReferrerDomainRestriction.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.ReferrerDomainRestriction
2 | A list of domains allowed to play your videos.
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **AllowedDomains** | **List<string>** | List of domains allowed to play videos. Possible values are * `[]` Empty Array indicates deny video playback requests for all domains * `[\"*\"]` A Single Wildcard `*` entry means allow video playback requests from any domain * `[\"*.example.com\", \"foo.com\"]` A list of up to 10 domains or valid dns-style wildcards | [optional]
9 | **AllowNoReferrer** | **bool** | A boolean to determine whether to allow or deny HTTP requests without `Referer` HTTP request header. Playback requests coming from non-web/native applications like iOS, Android or smart TVs will not have a `Referer` HTTP header. Set this value to `true` to allow these playback requests. | [optional] [default to false]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/ReloadWebInputResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.ReloadWebInputResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | **Object** | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/Score.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.Score
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **WatchTime** | **long?** | | [optional]
8 | **ViewCount** | **long** | | [optional]
9 | **UniqueViewers** | **long** | | [optional]
10 | **StartedViews** | **long** | | [optional]
11 | **TotalPlayingTime** | **long?** | | [optional]
12 | **Name** | **string** | | [optional]
13 | **EndedViews** | **long** | | [optional]
14 | **Value** | **double** | | [optional]
15 | **Type** | **string** | | [optional]
16 | **Metric** | **string** | | [optional]
17 | **Items** | [**List<Metric>**](Metric.md) | | [optional]
18 |
19 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
20 |
21 |
--------------------------------------------------------------------------------
/docs/ShutdownWebInputResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.ShutdownWebInputResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | **Object** | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/SignalLiveStreamCompleteResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.SignalLiveStreamCompleteResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | **Object** | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/SigningKey.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.SigningKey
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Id** | **string** | Unique identifier for the Signing Key. | [optional]
8 | **CreatedAt** | **string** | Time at which the object was created. Measured in seconds since the Unix epoch. | [optional]
9 | **PrivateKey** | **byte[]** | A Base64 encoded private key that can be used with the RS256 algorithm when creating a [JWT](https://jwt.io/). **Note that this value is only returned once when creating a URL signing key.** | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/SigningKeyResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.SigningKeyResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**SigningKey**](SigningKey.md) | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/SimulcastTargetResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.SimulcastTargetResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**SimulcastTarget**](SimulcastTarget.md) | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/StaticRendition.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.StaticRendition
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Name** | **string** | Name of the static rendition file | [optional]
8 | **Ext** | **string** | Extension of the static rendition file | [optional]
9 | **Height** | **int** | The height of the static rendition's file in pixels | [optional]
10 | **Width** | **int** | The width of the static rendition's file in pixels | [optional]
11 | **Bitrate** | **long** | The bitrate in bits per second | [optional]
12 | **Filesize** | **string** | The file size in bytes | [optional]
13 | **Type** | **string** | Indicates the static rendition type of this specific MP4 version of this asset. This field is only valid for `static_renditions`, not for `mp4_support`. | [optional]
14 | **Status** | **string** | Indicates the status of this specific MP4 version of this asset. This field is only valid for `static_renditions`, not for `mp4_support`. * `ready` indicates the MP4 has been generated and is ready for download * `preparing` indicates the asset has not been ingested or the static rendition is still being generated after an asset is ready * `skipped` indicates the static rendition will not be generated because the requested resolution conflicts with the asset attributes after the asset has been ingested * `errored` indicates the static rendition cannot be generated. For example, an asset could not be ingested | [optional]
15 | **ResolutionTier** | **string** | Indicates the resolution tier of this specific MP4 version of this asset. This field is only valid for `static_renditions`, not for `mp4_support`. | [optional]
16 | **Resolution** | **string** | Indicates the resolution of this specific MP4 version of this asset. This field is only valid for `static_renditions`, not for `mp4_support`. | [optional]
17 | **Id** | **string** | The ID of this static rendition, used in managing this static rendition. This field is only valid for `static_renditions`, not for `mp4_support`. | [optional]
18 | **Passthrough** | **string** | Arbitrary user-supplied metadata set for the static rendition. Max 255 characters. | [optional]
19 |
20 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
21 |
22 |
--------------------------------------------------------------------------------
/docs/TranscriptionVocabulary.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.TranscriptionVocabulary
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Id** | **string** | Unique identifier for the Transcription Vocabulary | [optional]
8 | **Name** | **string** | The user-supplied name of the Transcription Vocabulary. | [optional]
9 | **Phrases** | **List<string>** | Phrases, individual words, or proper names to include in the Transcription Vocabulary. When the Transcription Vocabulary is attached to a live stream's `generated_subtitles` configuration, the probability of successful speech recognition for these words or phrases is boosted. | [optional]
10 | **Passthrough** | **string** | Arbitrary user-supplied metadata set for the Transcription Vocabulary. Max 255 characters. | [optional]
11 | **CreatedAt** | **string** | Time the Transcription Vocabulary was created, defined as a Unix timestamp (seconds since epoch). | [optional]
12 | **UpdatedAt** | **string** | Time the Transcription Vocabulary was updated, defined as a Unix timestamp (seconds since epoch). | [optional]
13 |
14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15 |
16 |
--------------------------------------------------------------------------------
/docs/TranscriptionVocabularyResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.TranscriptionVocabularyResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**TranscriptionVocabulary**](TranscriptionVocabulary.md) | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/UpdateAssetMP4SupportRequest.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.UpdateAssetMP4SupportRequest
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Mp4Support** | **string** | Specify what level of support for mp4 playback. * The `capped-1080p` option produces a single MP4 file, called `capped-1080p.mp4`, with the video resolution capped at 1080p. This option produces an `audio.m4a` file for an audio-only asset. * The `audio-only` option produces a single M4A file, called `audio.m4a` for a video or an audio-only asset. MP4 generation will error when this option is specified for a video-only asset. * The `audio-only,capped-1080p` option produces both the `audio.m4a` and `capped-1080p.mp4` files. Only the `capped-1080p.mp4` file is produced for a video-only asset, while only the `audio.m4a` file is produced for an audio-only asset. The `standard`(deprecated) option produces up to three MP4 files with different levels of resolution (`high.mp4`, `medium.mp4`, `low.mp4`, or `audio.m4a` for an audio-only asset). `none` will delete the MP4s from the asset in question. | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/UpdateAssetMasterAccessRequest.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.UpdateAssetMasterAccessRequest
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **MasterAccess** | **string** | Add or remove access to the master version of the video. | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/UpdateAssetRequest.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.UpdateAssetRequest
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Passthrough** | **string** | You can set this field to anything you want. It will be included in the asset details and related webhooks. If you're looking for more structured metadata, such as `title` or `external_id` , you can use the `meta` object instead. **Max: 255 characters**. In order to clear this value, the field should be included with an empty string value. | [optional]
8 | **Meta** | [**AssetMetadata**](AssetMetadata.md) | | [optional]
9 |
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 |
12 |
--------------------------------------------------------------------------------
/docs/UpdateLiveStreamEmbeddedSubtitlesRequest.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.UpdateLiveStreamEmbeddedSubtitlesRequest
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **EmbeddedSubtitles** | [**List<LiveStreamEmbeddedSubtitleSettings>**](LiveStreamEmbeddedSubtitleSettings.md) | Describe the embedded closed caption contents of the incoming live stream. | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/UpdateLiveStreamGeneratedSubtitlesRequest.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.UpdateLiveStreamGeneratedSubtitlesRequest
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **GeneratedSubtitles** | [**List<LiveStreamGeneratedSubtitleSettings>**](LiveStreamGeneratedSubtitleSettings.md) | Update automated speech recognition subtitle configuration for a live stream. At most one subtitle track is allowed. | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/UpdateLiveStreamNewAssetSettings.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.UpdateLiveStreamNewAssetSettings
2 | Updates the new asset settings to use to generate a new asset for this live stream. Only the `mp4_support`, `master_access`, and `video_quality` settings may be updated.
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **Mp4Support** | **string** | Deprecated. See the [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions#during-live-stream-creation) for the updated API. Specify what level of support for mp4 playback should be added to new assets generated from this live stream. * The `none` option disables MP4 support for new assets. MP4 files will not be produced for an asset generated from this live stream. * The `capped-1080p` option produces a single MP4 file, called `capped-1080p.mp4`, with the video resolution capped at 1080p. This option produces an `audio.m4a` file for an audio-only asset. * The `audio-only` option produces a single M4A file, called `audio.m4a` for a video or an audio-only asset. MP4 generation will error when this option is specified for a video-only asset. * The `audio-only,capped-1080p` option produces both the `audio.m4a` and `capped-1080p.mp4` files. Only the `capped-1080p.mp4` file is produced for a video-only asset, while only the `audio.m4a` file is produced for an audio-only asset. * The `standard`(deprecated) option produces up to three MP4 files with different levels of resolution (`high.mp4`, `medium.mp4`, `low.mp4`, or `audio.m4a` for an audio-only asset). | [optional]
9 | **MasterAccess** | **string** | Add or remove access to the master version of the video. | [optional]
10 | **VideoQuality** | **string** | The video quality controls the cost, quality, and available platform features for the asset. [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels) | [optional]
11 | **Meta** | [**AssetMetadata**](AssetMetadata.md) | | [optional]
12 |
13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14 |
15 |
--------------------------------------------------------------------------------
/docs/UpdateLiveStreamNewAssetSettingsStaticRenditionsRequest.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.UpdateLiveStreamNewAssetSettingsStaticRenditionsRequest
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **StaticRenditions** | [**List<CreateStaticRenditionRequest>**](CreateStaticRenditionRequest.md) | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/UpdateReferrerDomainRestrictionRequest.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.UpdateReferrerDomainRestrictionRequest
2 | A list of domains allowed to play your videos.
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **AllowedDomains** | **List<string>** | List of domains allowed to play videos. Possible values are * `[]` Empty Array indicates deny video playback requests for all domains * `[\"*\"]` A Single Wildcard `*` entry means allow video playback requests from any domain * `[\"*.example.com\", \"foo.com\"]` A list of up to 10 domains or valid dns-style wildcards | [optional]
9 | **AllowNoReferrer** | **bool** | A boolean to determine whether to allow or deny HTTP requests without `Referer` HTTP request header. Playback requests coming from non-web/native applications like iOS, Android or smart TVs will not have a `Referer` HTTP header. Set this value to `true` to allow these playback requests. | [optional] [default to false]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/UpdateTranscriptionVocabularyRequest.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.UpdateTranscriptionVocabularyRequest
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Name** | **string** | The user-supplied name of the Transcription Vocabulary. | [optional]
8 | **Phrases** | **List<string>** | Phrases, individual words, or proper names to include in the Transcription Vocabulary. When the Transcription Vocabulary is attached to a live stream's `generated_subtitles`, the probability of successful speech recognition for these words or phrases is boosted. |
9 | **Passthrough** | **string** | Arbitrary user-supplied metadata set for the Transcription Vocabulary. Max 255 characters. | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/UpdateUserAgentRestrictionRequest.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.UpdateUserAgentRestrictionRequest
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **AllowNoUserAgent** | **bool** | Whether or not to allow views without a `User-Agent` HTTP request header. | [optional] [default to true]
8 | **AllowHighRiskUserAgent** | **bool** | Whether or not to allow high risk user agents. The high risk user agents are defined by Mux. | [optional] [default to true]
9 |
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 |
12 |
--------------------------------------------------------------------------------
/docs/UpdateWebInputUrlRequest.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.UpdateWebInputUrlRequest
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Url** | **string** | The URL for the Web Input to load. | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/Upload.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.Upload
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Id** | **string** | Unique identifier for the Direct Upload. | [optional]
8 | **Timeout** | **int** | 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]
9 | **Status** | **string** | | [optional]
10 | **NewAssetSettings** | [**CreateAssetRequest**](CreateAssetRequest.md) | | [optional]
11 | **AssetId** | **string** | Only set once the upload is in the `asset_created` state. | [optional]
12 | **Error** | [**UploadError**](UploadError.md) | | [optional]
13 | **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]
14 | **Url** | **string** | The URL to upload the associated source media to. | [optional]
15 | **Test** | **bool** | Indicates if this is a test Direct Upload, in which case the Asset that gets created will be a `test` Asset. | [optional]
16 |
17 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
18 |
19 |
--------------------------------------------------------------------------------
/docs/UploadError.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.UploadError
2 | Only set if an error occurred during asset creation.
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **Type** | **string** | Label for the specific error | [optional]
9 | **Message** | **string** | Human readable error message | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/UploadResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.UploadResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**Upload**](Upload.md) | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/docs/UserAgentRestrictionRequest.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.UserAgentRestrictionRequest
2 | Rules that control what user agents are allowed to play your videos. Please see [Using User-Agent HTTP header for validation](https://docs.mux.com/guides/secure-video-playback#using-user-agent-http-header-for-validation) for more details on this feature.
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **AllowNoUserAgent** | **bool** | Whether or not to allow views without a `User-Agent` HTTP request header. | [optional] [default to true]
9 | **AllowHighRiskUserAgent** | **bool** | Whether or not to allow high risk user agents. The high risk user agents are defined by Mux. | [optional] [default to true]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/UserAgentRestrictionSettings.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.UserAgentRestrictionSettings
2 | Rules that control what user agents are allowed to play your videos. Please see [Using User-Agent HTTP header for validation](https://docs.mux.com/guides/secure-video-playback#using-user-agent-http-header-for-validation) for more details on this feature.
3 |
4 | ## Properties
5 |
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | **AllowNoUserAgent** | **bool** | Whether or not to allow views without a `User-Agent` HTTP request header. | [optional] [default to true]
9 | **AllowHighRiskUserAgent** | **bool** | Whether or not to allow high risk user agents. The high risk user agents are defined by Mux. | [optional] [default to true]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/VideoViewEvent.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.VideoViewEvent
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **ViewerTime** | **long** | | [optional]
8 | **PlaybackTime** | **long** | | [optional]
9 | **Name** | **string** | | [optional]
10 | **EventTime** | **long** | | [optional]
11 | **Details** | **Dictionary<string, Object>** | | [optional]
12 |
13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14 |
15 |
--------------------------------------------------------------------------------
/docs/VideoViewResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.VideoViewResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**VideoView**](VideoView.md) | | [optional]
8 | **Timeframe** | **List<long>** | | [optional]
9 | **TotalRowCount** | **long?** | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
--------------------------------------------------------------------------------
/docs/WebInput.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.WebInput
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Id** | **string** | Unique identifier for the Web Input. | [optional]
8 | **CreatedAt** | **string** | Time the Web Input was created, defined as a Unix timestamp (seconds since epoch). | [optional]
9 | **Url** | **string** | The URL for the Web Input to load. | [optional]
10 | **AutoLaunch** | **bool** | When set to `true` the Web Input will automatically launch and start streaming immediately after creation | [optional]
11 | **LiveStreamId** | **string** | The Live Stream ID to broadcast this Web Input to | [optional]
12 | **Status** | **string** | | [optional]
13 | **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]
14 | **Resolution** | **string** | The resolution of the viewport of the Web Input's browser instance. Defaults to 1920x1080 if not set. | [optional] [default to ResolutionEnum._1920x1080]
15 | **Timeout** | **int** | The number of seconds that the Web Input should stream for before automatically shutting down. | [optional] [default to 3600]
16 |
17 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
18 |
19 |
--------------------------------------------------------------------------------
/docs/WebInputResponse.md:
--------------------------------------------------------------------------------
1 | # Mux.Csharp.Sdk.Model.WebInputResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **Data** | [**WebInput**](WebInput.md) | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
--------------------------------------------------------------------------------
/gen/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules/
2 | tmp/
3 |
4 | *.log
5 | *.bak
6 |
7 | template-changes.diff
--------------------------------------------------------------------------------
/gen/Makefile:
--------------------------------------------------------------------------------
1 | # per-SDK stuff
2 | GENERATOR_TYPE=csharp-netcore
3 |
4 | ###### helper variables ######
5 | # this is in case we want to go to Docker or something other than running yarn
6 | # for OAS in the future. also less typing.
7 | OAS_CLI=yarn run -s oas
8 | CONFIG_PATH=./generator-config.json
9 | OUTPUT_DIR=..
10 | TEMPLATE_DIR=./templates
11 | GENERATED_TEMPLATE_DIR=./tmp/oas-base-templates
12 |
13 | ensure:
14 | yarn install
15 |
16 | clean:
17 | rm -rf tmp
18 |
19 | clean-products:
20 | rm -rf "${OUTPUT_DIR}/lib"
21 | rm -rf "${OUTPUT_DIR}/docs"
22 |
23 | build: ensure clean-products
24 | ${OAS_CLI} generate -g "${GENERATOR_TYPE}" -c "${CONFIG_PATH}" -t "${TEMPLATE_DIR}" -o "${OUTPUT_DIR}" -i "${OAS_SPEC_PATH}"
25 |
26 | config-help: ensure
27 | ${OAS_CLI} config-help -g "${GENERATOR_TYPE}"
28 |
29 | template-diff: ensure
30 | ${OAS_CLI} author template -g "${GENERATOR_TYPE}" -o "${GENERATED_TEMPLATE_DIR}"
31 | diff "${TEMPLATE_DIR}" "${GENERATED_TEMPLATE_DIR}" > ./tmp/template-changes.diff
32 |
--------------------------------------------------------------------------------
/gen/generator-config.json:
--------------------------------------------------------------------------------
1 | {
2 | "!!source": "https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/csharp-netcore.md",
3 | "packageVersion": "2.0.1",
4 | "caseInsensitiveResponseHeaders": true,
5 | "disallowAdditionalPropertiesIfNotPresent": false,
6 | "licenseID": "MIT",
7 | "nullableReferenceTypes": false,
8 | "packageName": "Mux.Csharp.Sdk",
9 | "packageAuthors": "Mux DevEx Team",
10 | "packageCompany": "Mux",
11 | "packageTitle": "Mux SDK for .NET Core",
12 | "packageDescription": "The Mux API SDK for .NET Framework and .NET Core. Check https://github.com/muxinc/mux-csharp for release notes and visit https://docs.mux.com for details on using Mux.",
13 | "packageCopyright": "(C) 2023 Mux, Inc.",
14 | "releaseNote": "Check https://github.com/muxinc/mux-csharp for release notes.",
15 | "returnICollection": true
16 | }
17 |
--------------------------------------------------------------------------------
/gen/openapitools.json:
--------------------------------------------------------------------------------
1 | {
2 | "$schema": "node_modules/@openapitools/openapi-generator-cli/config.schema.json",
3 | "spaces": 2,
4 | "generator-cli": {
5 | "version": "5.4.0"
6 | }
7 | }
8 |
--------------------------------------------------------------------------------
/gen/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "private": true,
3 | "scripts": {
4 | "oas": "openapi-generator-cli",
5 | "current-version": "jq -r .gemVersion < ./generator-config.json",
6 | "compute-next-version:patch": "semver $(yarn run --silent current-version) -i patch",
7 | "compute-next-version:minor": "semver $(yarn run --silent current-version) -i minor",
8 | "compute-next-version:major": "semver $(yarn run --silent current-version) -i major",
9 | "bump-version:patch": "jq -r \".gemVersion = \\\"$(yarn run -s compute-next-version:patch)\\\"\" < ./generator-config.json > ./generator-config.tmp.json && cp ./generator-config.json ./generator-config.json.bak && mv ./generator-config.tmp.json ./generator-config.json",
10 | "build": ""
11 | },
12 | "dependencies": {
13 | "@openapitools/openapi-generator-cli": "^2.4.26",
14 | "node-jq": "^2.3.3",
15 | "semver": "^7.3.7"
16 | }
17 | }
18 |
--------------------------------------------------------------------------------
/gen/templates/ApiException.mustache:
--------------------------------------------------------------------------------
1 | {{>partial_header}}
2 |
3 | using System;
4 |
5 | namespace {{packageName}}.Client
6 | {
7 | ///
8 | /// API Exception
9 | ///
10 | {{>visibility}} class ApiException : Exception
11 | {
12 | ///
13 | /// Gets or sets the error code (HTTP status code)
14 | ///
15 | /// The error code (HTTP status code).
16 | public int ErrorCode { get; set; }
17 |
18 | ///
19 | /// Gets or sets the error content (body json object)
20 | ///
21 | /// The error content (Http response body).
22 | public object ErrorContent { get; private set; }
23 |
24 | ///
25 | /// Gets or sets the HTTP headers
26 | ///
27 | /// HTTP headers
28 | public Multimap Headers { get; private set; }
29 |
30 | ///
31 | /// Initializes a new instance of the class.
32 | ///
33 | public ApiException() { }
34 |
35 | ///
36 | /// Initializes a new instance of the class.
37 | ///
38 | /// HTTP status code.
39 | /// Error message.
40 | public ApiException(int errorCode, string message) : base(message)
41 | {
42 | this.ErrorCode = errorCode;
43 | }
44 |
45 | ///
46 | /// Initializes a new instance of the class.
47 | ///
48 | /// HTTP status code.
49 | /// Error message.
50 | /// Error content.
51 | /// HTTP Headers.
52 | public ApiException(int errorCode, string message, object errorContent = null, Multimap headers = null) : base(message)
53 | {
54 | this.ErrorCode = errorCode;
55 | this.ErrorContent = errorContent;
56 | this.Headers = headers;
57 | }
58 | }
59 |
60 | }
61 |
--------------------------------------------------------------------------------
/gen/templates/AssemblyInfo.mustache:
--------------------------------------------------------------------------------
1 | using System.Reflection;
2 | using System.Runtime.CompilerServices;
3 | using System.Runtime.InteropServices;
4 |
5 | // General Information about an assembly is controlled through the following
6 | // set of attributes. Change these attribute values to modify the information
7 | // associated with an assembly.
8 | [assembly: AssemblyTitle("{{packageTitle}}")]
9 | [assembly: AssemblyDescription("{{packageDescription}}")]
10 | [assembly: AssemblyConfiguration("")]
11 | [assembly: AssemblyCompany("{{packageCompany}}")]
12 | [assembly: AssemblyProduct("{{packageProductName}}")]
13 | [assembly: AssemblyCopyright("{{packageCopyright}}")]
14 | [assembly: AssemblyTrademark("")]
15 | [assembly: AssemblyCulture("")]
16 |
17 | // Setting ComVisible to false makes the types in this assembly not visible
18 | // to COM components. If you need to access a type in this assembly from
19 | // COM, set the ComVisible attribute to true on that type.
20 | [assembly: ComVisible(false)]
21 |
22 | // Version information for an assembly consists of the following four values:
23 | //
24 | // Major Version
25 | // Minor Version
26 | // Build Number
27 | // Revision
28 | //
29 | // You can specify all the values or you can default the Build and Revision Numbers
30 | // by using the '*' as shown below:
31 | // [assembly: AssemblyVersion("1.0.*")]
32 | [assembly: AssemblyVersion("{{packageVersion}}")]
33 | [assembly: AssemblyFileVersion("{{packageVersion}}")]
34 | {{^supportsAsync}}
35 | // Settings which don't support asynchronous operations rely on non-public constructors
36 | // This is due to how RestSharp requires the type constraint `where T : new()` in places it probably shouldn't.
37 | [assembly: InternalsVisibleTo("RestSharp")]
38 | [assembly: InternalsVisibleTo("NewtonSoft.Json")]
39 | [assembly: InternalsVisibleTo("JsonSubTypes")]
40 | {{/supportsAsync}}
41 |
--------------------------------------------------------------------------------
/gen/templates/ExceptionFactory.mustache:
--------------------------------------------------------------------------------
1 | {{>partial_header}}
2 |
3 | using System;
4 |
5 | namespace {{packageName}}.Client
6 | {
7 | ///
8 | /// A delegate to ExceptionFactory method
9 | ///
10 | /// Method name
11 | /// Response
12 | /// Exceptions
13 | {{>visibility}} delegate Exception ExceptionFactory(string methodName, IApiResponse response);
14 | }
15 |
--------------------------------------------------------------------------------
/gen/templates/GlobalConfiguration.mustache:
--------------------------------------------------------------------------------
1 | {{>partial_header}}
2 |
3 | using System.Collections.Generic;
4 |
5 | namespace {{packageName}}.Client
6 | {
7 | ///
8 | /// provides a compile-time extension point for globally configuring
9 | /// API Clients.
10 | ///
11 | ///
12 | /// A customized implementation via partial class may reside in another file and may
13 | /// be excluded from automatic generation via a .openapi-generator-ignore file.
14 | ///
15 | {{>visibility}} partial class GlobalConfiguration : Configuration
16 | {
17 | #region Private Members
18 |
19 | private static readonly object GlobalConfigSync = new { };
20 | private static IReadableConfiguration _globalConfiguration;
21 |
22 | #endregion Private Members
23 |
24 | #region Constructors
25 |
26 | ///
27 | private GlobalConfiguration()
28 | {
29 | }
30 |
31 | ///
32 | public GlobalConfiguration(IDictionary defaultHeader, IDictionary apiKey, IDictionary apiKeyPrefix, string basePath = "http://localhost:3000/api") : base(defaultHeader, apiKey, apiKeyPrefix, basePath)
33 | {
34 | }
35 |
36 | static GlobalConfiguration()
37 | {
38 | Instance = new GlobalConfiguration();
39 | }
40 |
41 | #endregion Constructors
42 |
43 | ///
44 | /// Gets or sets the default Configuration.
45 | ///
46 | /// Configuration.
47 | public static IReadableConfiguration Instance
48 | {
49 | get { return _globalConfiguration; }
50 | set
51 | {
52 | lock (GlobalConfigSync)
53 | {
54 | _globalConfiguration = value;
55 | }
56 | }
57 | }
58 | }
59 | }
60 |
--------------------------------------------------------------------------------
/gen/templates/HttpMethod.mustache:
--------------------------------------------------------------------------------
1 | {{>partial_header}}
2 |
3 | namespace {{packageName}}.Client
4 | {
5 | ///
6 | /// Http methods supported by swagger
7 | ///
8 | public enum HttpMethod
9 | {
10 | /// HTTP GET request.
11 | Get,
12 | /// HTTP POST request.
13 | Post,
14 | /// HTTP PUT request.
15 | Put,
16 | /// HTTP DELETE request.
17 | Delete,
18 | /// HTTP HEAD request.
19 | Head,
20 | /// HTTP OPTIONS request.
21 | Options,
22 | /// HTTP PATCH request.
23 | Patch
24 | }
25 | }
26 |
--------------------------------------------------------------------------------
/gen/templates/IApiAccessor.mustache:
--------------------------------------------------------------------------------
1 | {{>partial_header}}
2 |
3 | using System;
4 |
5 | namespace {{packageName}}.Client
6 | {
7 | ///
8 | /// Represents configuration aspects required to interact with the API endpoints.
9 | ///
10 | {{>visibility}} interface IApiAccessor
11 | {
12 | ///
13 | /// Gets or sets the configuration object
14 | ///
15 | /// An instance of the Configuration
16 | IReadableConfiguration Configuration { get; set; }
17 |
18 | ///
19 | /// Gets the base path of the API client.
20 | ///
21 | /// The base path
22 | string GetBasePath();
23 |
24 | ///
25 | /// Provides a factory method hook for the creation of exceptions.
26 | ///
27 | ExceptionFactory ExceptionFactory { get; set; }
28 | }
29 | }
30 |
--------------------------------------------------------------------------------
/gen/templates/OpenAPIDateConverter.mustache:
--------------------------------------------------------------------------------
1 | {{>partial_header}}
2 | using Newtonsoft.Json.Converters;
3 |
4 | namespace {{packageName}}.Client
5 | {
6 | ///
7 | /// Formatter for 'date' openapi formats ss defined by full-date - RFC3339
8 | /// see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#data-types
9 | ///
10 | public class OpenAPIDateConverter : IsoDateTimeConverter
11 | {
12 | ///
13 | /// Initializes a new instance of the class.
14 | ///
15 | public OpenAPIDateConverter()
16 | {
17 | // full-date = date-fullyear "-" date-month "-" date-mday
18 | DateTimeFormat = "yyyy-MM-dd";
19 | }
20 | }
21 | }
22 |
--------------------------------------------------------------------------------
/gen/templates/RequestOptions.mustache:
--------------------------------------------------------------------------------
1 | {{>partial_header}}
2 |
3 | using System;
4 | using System.Collections.Generic;
5 | using System.IO;
6 | using System.Net;
7 |
8 | namespace {{packageName}}.Client
9 | {
10 | ///
11 | /// A container for generalized request inputs. This type allows consumers to extend the request functionality
12 | /// by abstracting away from the default (built-in) request framework (e.g. RestSharp).
13 | ///
14 | public class RequestOptions
15 | {
16 | ///
17 | /// Parameters to be bound to path parts of the Request's URL
18 | ///
19 | public Dictionary PathParameters { get; set; }
20 |
21 | ///
22 | /// Query parameters to be applied to the request.
23 | /// Keys may have 1 or more values associated.
24 | ///
25 | public Multimap QueryParameters { get; set; }
26 |
27 | ///
28 | /// Header parameters to be applied to to the request.
29 | /// Keys may have 1 or more values associated.
30 | ///
31 | public Multimap HeaderParameters { get; set; }
32 |
33 | ///
34 | /// Form parameters to be sent along with the request.
35 | ///
36 | public Dictionary FormParameters { get; set; }
37 |
38 | ///
39 | /// File parameters to be sent along with the request.
40 | ///
41 | public Multimap FileParameters { get; set; }
42 |
43 | ///
44 | /// Cookies to be sent along with the request.
45 | ///
46 | public List Cookies { get; set; }
47 |
48 | ///
49 | /// Any data associated with a request body.
50 | ///
51 | public Object Data { get; set; }
52 |
53 | ///
54 | /// Constructs a new instance of
55 | ///
56 | public RequestOptions()
57 | {
58 | PathParameters = new Dictionary();
59 | QueryParameters = new Multimap();
60 | HeaderParameters = new Multimap();
61 | FormParameters = new Dictionary();
62 | FileParameters = new Multimap();
63 | Cookies = new List();
64 | }
65 | }
66 | }
67 |
--------------------------------------------------------------------------------
/gen/templates/RetryConfiguration.mustache:
--------------------------------------------------------------------------------
1 | {{>partial_header}}
2 |
3 | using Polly;
4 | {{#useRestSharp}}
5 | using RestSharp;
6 | {{/useRestSharp}}
7 | {{#useHttpClient}}
8 | using System.Net.Http;
9 | {{/useHttpClient}}
10 |
11 | namespace {{packageName}}.Client
12 | {
13 | ///
14 | /// Configuration class to set the polly retry policies to be applied to the requests.
15 | ///
16 | public static class RetryConfiguration
17 | {
18 | {{#useRestSharp}}
19 | ///
20 | /// Retry policy
21 | ///
22 | public static Policy RetryPolicy { get; set; }
23 |
24 | ///
25 | /// Async retry policy
26 | ///
27 | public static AsyncPolicy AsyncRetryPolicy { get; set; }
28 | {{/useRestSharp}}
29 | {{#useHttpClient}}
30 | ///
31 | /// Retry policy
32 | ///
33 | public static Policy RetryPolicy { get; set; }
34 |
35 | ///
36 | /// Async retry policy
37 | ///
38 | public static AsyncPolicy AsyncRetryPolicy { get; set; }
39 | {{/useHttpClient}}
40 | }
41 | }
42 |
--------------------------------------------------------------------------------
/gen/templates/Solution.mustache:
--------------------------------------------------------------------------------
1 | Microsoft Visual Studio Solution File, Format Version 12.00
2 | # Visual Studio {{^netStandard}}2012{{/netStandard}}{{#netStandard}}14{{/netStandard}}
3 | VisualStudioVersion = {{^netStandard}}12.0.0.0{{/netStandard}}{{#netStandard}}14.0.25420.1{{/netStandard}}
4 | MinimumVisualStudioVersion = {{^netStandard}}10.0.0.1{{/netStandard}}{{#netStandard}}10.0.40219.1{{/netStandard}}
5 | Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "{{packageName}}", "src\{{packageName}}\{{packageName}}.csproj", "{{packageGuid}}"
6 | EndProject
7 | {{^excludeTests}}Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "{{testPackageName}}", "src\{{testPackageName}}\{{testPackageName}}.csproj", "{19F1DEBC-DE5E-4517-8062-F000CD499087}"
8 | EndProject
9 | {{/excludeTests}}Global
10 | GlobalSection(SolutionConfigurationPlatforms) = preSolution
11 | Debug|Any CPU = Debug|Any CPU
12 | Release|Any CPU = Release|Any CPU
13 | EndGlobalSection
14 | GlobalSection(ProjectConfigurationPlatforms) = postSolution
15 | {{packageGuid}}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
16 | {{packageGuid}}.Debug|Any CPU.Build.0 = Debug|Any CPU
17 | {{packageGuid}}.Release|Any CPU.ActiveCfg = Release|Any CPU
18 | {{packageGuid}}.Release|Any CPU.Build.0 = Release|Any CPU
19 | {19F1DEBC-DE5E-4517-8062-F000CD499087}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
20 | {19F1DEBC-DE5E-4517-8062-F000CD499087}.Debug|Any CPU.Build.0 = Debug|Any CPU
21 | {19F1DEBC-DE5E-4517-8062-F000CD499087}.Release|Any CPU.ActiveCfg = Release|Any CPU
22 | {19F1DEBC-DE5E-4517-8062-F000CD499087}.Release|Any CPU.Build.0 = Release|Any CPU
23 | EndGlobalSection
24 | GlobalSection(SolutionProperties) = preSolution
25 | HideSolutionNode = FALSE
26 | EndGlobalSection
27 | EndGlobal
--------------------------------------------------------------------------------
/gen/templates/TestProject.mustache:
--------------------------------------------------------------------------------
1 |
2 |
14 |
15 |
16 | false
17 | Properties
18 | {{testPackageName}}
19 | {{testPackageName}}
20 | {{testTargetFramework}}
21 | false
22 | 512
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 | {{packageGuid}}
32 | {{packageName}}
33 |
34 |
35 |
36 |
--------------------------------------------------------------------------------
/gen/templates/WebRequestPathBuilder.mustache:
--------------------------------------------------------------------------------
1 | {{>partial_header}}
2 | using System.Collections.Generic;
3 | using System.Web;
4 |
5 | namespace {{packageName}}.Client
6 | {
7 | ///
8 | /// A URI builder
9 | ///
10 | class WebRequestPathBuilder
11 | {
12 | private string _baseUrl;
13 | private string _path;
14 | private string _query = "?";
15 | public WebRequestPathBuilder(string baseUrl, string path)
16 | {
17 | _baseUrl = baseUrl;
18 | _path = path;
19 | }
20 |
21 | public void AddPathParameters(Dictionary parameters)
22 | {
23 | foreach (var parameter in parameters)
24 | {
25 | _path = _path.Replace("{" + parameter.Key + "}", HttpUtility.UrlEncode(parameter.Value));
26 | }
27 | }
28 |
29 | public void AddQueryParameters(Multimap parameters)
30 | {
31 | foreach (var parameter in parameters)
32 | {
33 | foreach (var value in parameter.Value)
34 | {
35 | _query = _query + parameter.Key + "=" + HttpUtility.UrlEncode(value) + "&";
36 | }
37 | }
38 | }
39 |
40 | public string GetFullUri()
41 | {
42 | return _baseUrl + _path + _query.Substring(0, _query.Length - 1);
43 | }
44 | }
45 | }
46 |
--------------------------------------------------------------------------------
/gen/templates/api_test.mustache:
--------------------------------------------------------------------------------
1 | {{>partial_header}}
2 | using System;
3 | using System.IO;
4 | using System.Collections.Generic;
5 | using System.Collections.ObjectModel;
6 | using System.Linq;
7 | using System.Reflection;
8 | {{#useRestSharp}}
9 | using RestSharp;
10 | {{/useRestSharp}}
11 | using Xunit;
12 |
13 | using {{packageName}}.Client;
14 | using {{packageName}}.{{apiPackage}};
15 | {{#hasImport}}
16 | // uncomment below to import models
17 | //using {{packageName}}.{{modelPackage}};
18 | {{/hasImport}}
19 |
20 | namespace {{packageName}}.Test.Api
21 | {
22 | ///
23 | /// Class for testing {{classname}}
24 | ///
25 | ///
26 | /// This file is automatically generated by OpenAPI Generator (https://openapi-generator.tech).
27 | /// Please update the test case below to test the API endpoint.
28 | ///
29 | public class {{classname}}Tests : IDisposable
30 | {
31 | {{^nonPublicApi}}
32 | private {{classname}} instance;
33 |
34 | {{/nonPublicApi}}
35 | public {{classname}}Tests()
36 | {
37 | {{^nonPublicApi}}
38 | instance = new {{classname}}();
39 | {{/nonPublicApi}}
40 | }
41 |
42 | public void Dispose()
43 | {
44 | // Cleanup when everything is done.
45 | }
46 |
47 | ///
48 | /// Test an instance of {{classname}}
49 | ///
50 | [Fact]
51 | public void {{operationId}}InstanceTest()
52 | {
53 | // TODO uncomment below to test 'IsType' {{classname}}
54 | //Assert.IsType<{{classname}}>(instance);
55 | }
56 | {{#operations}}
57 | {{#operation}}
58 |
59 | ///
60 | /// Test {{operationId}}
61 | ///
62 | [Fact]
63 | public void {{operationId}}Test()
64 | {
65 | // TODO uncomment below to test the method and replace null with proper value
66 | {{#allParams}}
67 | //{{{dataType}}} {{paramName}} = null;
68 | {{/allParams}}
69 | //{{#returnType}}var response = {{/returnType}}instance.{{operationId}}({{#allParams}}{{paramName}}{{^-last}}, {{/-last}}{{/allParams}});
70 | {{#returnType}}
71 | //Assert.IsType<{{{.}}}>(response);
72 | {{/returnType}}
73 | }
74 | {{/operation}}
75 | {{/operations}}
76 | }
77 | }
78 |
--------------------------------------------------------------------------------
/gen/templates/appveyor.mustache:
--------------------------------------------------------------------------------
1 | # auto-generated by OpenAPI Generator (https://github.com/OpenAPITools/openapi-generator)
2 | #
3 | image: Visual Studio 2019
4 | clone_depth: 1
5 | build_script:
6 | - dotnet build -c Release
7 | - dotnet test -c Release
8 | after_build:
9 | - dotnet pack .\src\{{{packageName}}}\{{{packageName}}}.csproj -o ../../output -c Release --no-build
10 |
--------------------------------------------------------------------------------
/gen/templates/git_push.sh.mustache:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | # ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
3 | #
4 | # Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
5 |
6 | git_user_id=$1
7 | git_repo_id=$2
8 | release_note=$3
9 | git_host=$4
10 |
11 | if [ "$git_host" = "" ]; then
12 | git_host="{{{gitHost}}}"
13 | echo "[INFO] No command line input provided. Set \$git_host to $git_host"
14 | fi
15 |
16 | if [ "$git_user_id" = "" ]; then
17 | git_user_id="{{{gitUserId}}}"
18 | echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
19 | fi
20 |
21 | if [ "$git_repo_id" = "" ]; then
22 | git_repo_id="{{{gitRepoId}}}"
23 | echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
24 | fi
25 |
26 | if [ "$release_note" = "" ]; then
27 | release_note="{{{releaseNote}}}"
28 | echo "[INFO] No command line input provided. Set \$release_note to $release_note"
29 | fi
30 |
31 | # Initialize the local directory as a Git repository
32 | git init
33 |
34 | # Adds the files in the local repository and stages them for commit.
35 | git add .
36 |
37 | # Commits the tracked changes and prepares them to be pushed to a remote repository.
38 | git commit -m "$release_note"
39 |
40 | # Sets the new remote
41 | git_remote=$(git remote)
42 | if [ "$git_remote" = "" ]; then # git remote not defined
43 |
44 | if [ "$GIT_TOKEN" = "" ]; then
45 | echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
46 | git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
47 | else
48 | git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
49 | fi
50 |
51 | fi
52 |
53 | git pull origin master
54 |
55 | # Pushes (Forces) the changes in the local repository up to the remote repository
56 | echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
57 | git push origin master 2>&1 | grep -v 'To https'
58 |
--------------------------------------------------------------------------------
/gen/templates/libraries/generichost/ApiException.mustache:
--------------------------------------------------------------------------------
1 | //
2 | {{>partial_header}}
3 | {{#nullableReferenceTypes}}#nullable enable{{/nullableReferenceTypes}}
4 |
5 | using System;
6 |
7 | namespace {{packageName}}.Client
8 | {
9 | ///
10 | /// API Exception
11 | ///
12 | {{>visibility}} class ApiException : Exception
13 | {
14 | ///
15 | /// The reason the api request failed
16 | ///
17 | public string{{#nullableReferenceTypes}}?{{/nullableReferenceTypes}} ReasonPhrase { get; }
18 |
19 | ///
20 | /// The HttpStatusCode
21 | ///
22 | public System.Net.HttpStatusCode StatusCode { get; }
23 |
24 | ///
25 | /// The raw data returned by the api
26 | ///
27 | public string RawContent { get; }
28 |
29 | ///
30 | /// Construct the ApiException from parts of the reponse
31 | ///
32 | ///
33 | ///
34 | ///
35 | public ApiException(string{{#nullableReferenceTypes}}?{{/nullableReferenceTypes}} reasonPhrase, System.Net.HttpStatusCode statusCode, string rawContent) : base(reasonPhrase ?? rawContent)
36 | {
37 | ReasonPhrase = reasonPhrase;
38 |
39 | StatusCode = statusCode;
40 |
41 | RawContent = rawContent;
42 | }
43 | }
44 | }
45 |
--------------------------------------------------------------------------------
/gen/templates/libraries/generichost/ApiKeyToken.mustache:
--------------------------------------------------------------------------------
1 | //
2 | {{partial_header}}
3 | {{#nullableReferenceTypes}}#nullable enable{{/nullableReferenceTypes}}
4 |
5 | using System;
6 |
7 | namespace {{packageName}}.Client
8 | {
9 | ///
10 | /// A token constructed from an apiKey.
11 | ///
12 | public class ApiKeyToken : TokenBase
13 | {
14 | private string _raw;
15 |
16 | ///
17 | /// Constructs an ApiKeyToken object.
18 | ///
19 | ///
20 | ///
21 | ///
22 | public ApiKeyToken(string value, string prefix = "Bearer ", TimeSpan? timeout = null) : base(timeout)
23 | {
24 | _raw = $"{ prefix }{ value }";
25 | }
26 |
27 | ///
28 | /// Places the token in the cookie.
29 | ///
30 | ///
31 | ///
32 | public virtual void UseInCookie(System.Net.Http.HttpRequestMessage request, string cookieName)
33 | {
34 | request.Headers.Add("Cookie", $"{ cookieName }=_raw");
35 | }
36 |
37 | ///
38 | /// Places the token in the header.
39 | ///
40 | ///
41 | ///
42 | public virtual void UseInHeader(System.Net.Http.HttpRequestMessage request, string headerName)
43 | {
44 | request.Headers.Add(headerName, _raw);
45 | }
46 |
47 | ///
48 | /// Places the token in the query.
49 | ///
50 | ///
51 | ///
52 | ///
53 | ///
54 | public virtual void UseInQuery(System.Net.Http.HttpRequestMessage request, UriBuilder uriBuilder, System.Collections.Specialized.NameValueCollection parseQueryString, string parameterName)
55 | {
56 | parseQueryString[parameterName] = Uri.EscapeDataString(_raw).ToString(){{#nullableReferenceTypes}}!{{/nullableReferenceTypes}};
57 | }
58 | }
59 | }
--------------------------------------------------------------------------------
/gen/templates/libraries/generichost/ApiResponseEventArgs.mustache:
--------------------------------------------------------------------------------
1 | using System;
2 | using System.Net;
3 |
4 | namespace {{packageName}}.Client
5 | {
6 | ///
7 | /// Useful for tracking server health.
8 | ///
9 | public class ApiResponseEventArgs : EventArgs
10 | {
11 | ///
12 | /// The time the request was sent.
13 | ///
14 | public DateTime RequestedAt { get; }
15 | ///
16 | /// The time the response was received.
17 | ///
18 | public DateTime ReceivedAt { get; }
19 | ///
20 | /// The HttpStatusCode received.
21 | ///
22 | public HttpStatusCode HttpStatus { get; }
23 | ///
24 | /// The path requested.
25 | ///
26 | public string Path { get; }
27 | ///
28 | /// The elapsed time from request to response.
29 | ///
30 | public TimeSpan ToTimeSpan => this.ReceivedAt - this.RequestedAt;
31 |
32 | ///
33 | /// The event args used to track server health.
34 | ///
35 | ///
36 | ///
37 | ///
38 | ///
39 | public ApiResponseEventArgs(DateTime requestedAt, DateTime receivedAt, HttpStatusCode httpStatus, string path)
40 | {
41 | RequestedAt = requestedAt;
42 | ReceivedAt = receivedAt;
43 | HttpStatus = httpStatus;
44 | Path = path;
45 | }
46 | }
47 | }
48 |
--------------------------------------------------------------------------------
/gen/templates/libraries/generichost/ApiTestsBase.mustache:
--------------------------------------------------------------------------------
1 | {{>partial_header}}
2 | using System;
3 | using System.Collections.Generic;
4 | using System.Security.Cryptography;
5 | using Microsoft.Extensions.Hosting;
6 | using {{packageName}}.Client;{{#hasImport}}
7 | using {{packageName}}.{{modelPackage}};{{/hasImport}}
8 |
9 |
10 | {{{testInstructions}}}
11 |
12 |
13 | namespace {{packageName}}.Test.Api
14 | {
15 | ///
16 | /// Base class for API tests
17 | ///
18 | public class ApiTestsBase
19 | {
20 | protected readonly IHost _host;
21 |
22 | public ApiTestsBase(string[] args)
23 | {
24 | _host = CreateHostBuilder(args).Build();
25 | }
26 |
27 | public static IHostBuilder CreateHostBuilder(string[] args) => Host.CreateDefaultBuilder(args)
28 | .Configure{{apiName}}((context, options) =>
29 | {
30 | {{#hasApiKeyMethods}}ApiKeyToken apiKeyToken = new ApiKeyToken(context.Configuration[""], timeout: TimeSpan.FromSeconds(1));
31 | options.AddTokens(apiKeyToken);
32 | {{/hasApiKeyMethods}}{{#hasHttpBearerMethods}}
33 | BearerToken bearerToken = new BearerToken(context.Configuration[""], timeout: TimeSpan.FromSeconds(1));
34 | options.AddTokens(bearerToken);
35 | {{/hasHttpBearerMethods}}{{#hasHttpBasicMethods}}
36 | BasicToken basicToken = new BasicToken(context.Configuration[""], context.Configuration[""], timeout: TimeSpan.FromSeconds(1));
37 | options.AddTokens(basicToken);
38 | {{/hasHttpBasicMethods}}{{#hasHttpSignatureMethods}}
39 | HttpSigningConfiguration config = new HttpSigningConfiguration("", "", null, new List(), HashAlgorithmName.SHA256, "", 0);
40 | HttpSignatureToken httpSignatureToken = new HttpSignatureToken(config, timeout: TimeSpan.FromSeconds(1));
41 | options.AddTokens(httpSignatureToken);
42 | {{/hasHttpSignatureMethods}}{{#hasOAuthMethods}}
43 | OAuthToken oauthToken = new OAuthToken(context.Configuration[""], timeout: TimeSpan.FromSeconds(1));
44 | options.AddTokens(oauthToken);{{/hasOAuthMethods}}
45 | });
46 | }
47 | }
48 |
--------------------------------------------------------------------------------
/gen/templates/libraries/generichost/BasicToken.mustache:
--------------------------------------------------------------------------------
1 | //
2 | {{partial_header}}
3 | {{#nullableReferenceTypes}}#nullable enable{{/nullableReferenceTypes}}
4 |
5 | using System;
6 | using System.Linq;
7 | using System.Threading;
8 | using System.Threading.Tasks;
9 |
10 | namespace {{packageName}}.Client
11 | {
12 | ///
13 | /// A token constructed from a username and password.
14 | ///
15 | public class BasicToken : TokenBase
16 | {
17 | private string _username;
18 |
19 | private string _password;
20 |
21 | ///
22 | /// Constructs a BasicToken object.
23 | ///
24 | ///
25 | ///
26 | ///
27 | public BasicToken(string username, string password, TimeSpan? timeout = null) : base(timeout)
28 | {
29 | _username = username;
30 |
31 | _password = password;
32 | }
33 |
34 | ///
35 | /// Places the token in the header.
36 | ///
37 | ///
38 | ///
39 | public virtual void UseInHeader(System.Net.Http.HttpRequestMessage request, string headerName)
40 | {
41 | request.Headers.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("Basic", {{packageName}}.Client.ClientUtils.Base64Encode(_username + ":" + _password));
42 | }
43 | }
44 | }
--------------------------------------------------------------------------------
/gen/templates/libraries/generichost/BearerToken.mustache:
--------------------------------------------------------------------------------
1 | //
2 | {{partial_header}}
3 | {{#nullableReferenceTypes}}#nullable enable{{/nullableReferenceTypes}}
4 |
5 | using System;
6 | using System.Linq;
7 | using System.Threading;
8 | using System.Threading.Tasks;
9 |
10 | namespace {{packageName}}.Client
11 | {
12 | ///
13 | /// A token constructed from a token from a bearer token.
14 | ///
15 | public class BearerToken : TokenBase
16 | {
17 | private string _raw;
18 |
19 | ///
20 | /// Constructs a BearerToken object.
21 | ///
22 | ///
23 | ///
24 | public BearerToken(string value, TimeSpan? timeout = null) : base(timeout)
25 | {
26 | _raw = value;
27 | }
28 |
29 | ///
30 | /// Places the token in the header.
31 | ///
32 | ///
33 | ///
34 | public virtual void UseInHeader(System.Net.Http.HttpRequestMessage request, string headerName)
35 | {
36 | request.Headers.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("Bearer", _raw);
37 | }
38 | }
39 | }
--------------------------------------------------------------------------------
/gen/templates/libraries/generichost/HttpSigningToken.mustache:
--------------------------------------------------------------------------------
1 | //
2 | {{partial_header}}
3 | {{#nullableReferenceTypes}}#nullable enable{{/nullableReferenceTypes}}
4 |
5 | using System;
6 | using System.Linq;
7 | using System.Threading;
8 | using System.Threading.Tasks;
9 |
10 | namespace {{packageName}}.Client
11 | {
12 | ///
13 | /// A token constructed from an HttpSigningConfiguration
14 | ///
15 | public class HttpSignatureToken : TokenBase
16 | {
17 | private HttpSigningConfiguration _configuration;
18 |
19 | ///
20 | /// Constructs an HttpSignatureToken object.
21 | ///
22 | ///
23 | ///
24 | public HttpSignatureToken(HttpSigningConfiguration configuration, TimeSpan? timeout = null) : base(timeout)
25 | {
26 | _configuration = configuration;
27 | }
28 |
29 | ///
30 | /// Places the token in the header.
31 | ///
32 | ///
33 | ///
34 | ///
35 | public void UseInHeader(System.Net.Http.HttpRequestMessage request, string requestBody, CancellationToken? cancellationToken = null)
36 | {
37 | var signedHeaders = _configuration.GetHttpSignedHeader(request, requestBody, cancellationToken);
38 |
39 | foreach (var signedHeader in signedHeaders)
40 | request.Headers.Add(signedHeader.Key, signedHeader.Value);
41 | }
42 | }
43 | }
--------------------------------------------------------------------------------
/gen/templates/libraries/generichost/IApi.mustache:
--------------------------------------------------------------------------------
1 | using System.Net.Http;
2 |
3 | namespace {{packageName}}.Client
4 | {
5 | ///
6 | /// Any Api client
7 | ///
8 | public interface {{interfacePrefix}}Api
9 | {
10 | ///
11 | /// The HttpClient
12 | ///
13 | HttpClient HttpClient { get; }
14 |
15 | ///
16 | /// An event to track the health of the server.
17 | /// If you store these event args, be sure to purge old event args to prevent a memory leak.
18 | ///
19 | event ClientUtils.EventHandler{{#nullableReferenceTypes}}?{{/nullableReferenceTypes}} ApiResponded;
20 | }
21 | }
--------------------------------------------------------------------------------
/gen/templates/libraries/generichost/OAuthToken.mustache:
--------------------------------------------------------------------------------
1 | //
2 | {{partial_header}}
3 | {{#nullableReferenceTypes}}#nullable enable{{/nullableReferenceTypes}}
4 |
5 | using System;
6 | using System.Linq;
7 | using System.Threading;
8 | using System.Threading.Tasks;
9 |
10 | namespace {{packageName}}.Client
11 | {
12 | ///
13 | /// A token constructed with OAuth.
14 | ///
15 | public class OAuthToken : TokenBase
16 | {
17 | private string _raw;
18 |
19 | ///
20 | /// Consturcts an OAuthToken object.
21 | ///
22 | ///
23 | ///
24 | public OAuthToken(string value, TimeSpan? timeout = null) : base(timeout)
25 | {
26 | _raw = value;
27 | }
28 |
29 | ///
30 | /// Places the token in the header.
31 | ///
32 | ///
33 | ///
34 | public virtual void UseInHeader(System.Net.Http.HttpRequestMessage request, string headerName)
35 | {
36 | request.Headers.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("Bearer", _raw);
37 | }
38 | }
39 | }
--------------------------------------------------------------------------------
/gen/templates/libraries/generichost/TokenBase.mustache:
--------------------------------------------------------------------------------
1 | //
2 | {{partial_header}}
3 | {{#nullableReferenceTypes}}#nullable enable{{/nullableReferenceTypes}}
4 |
5 | using System;
6 |
7 | namespace {{packageName}}.Client
8 | {
9 | ///
10 | /// The base for all tokens.
11 | ///
12 | public abstract class TokenBase
13 | {
14 | private DateTime _nextAvailable = DateTime.UtcNow;
15 | private object _nextAvailableLock = new object();
16 | private readonly System.Timers.Timer _timer = new System.Timers.Timer();
17 |
18 |
19 | internal TimeSpan? Timeout { get; set; }
20 | internal delegate void TokenBecameAvailableEventHandler(object sender);
21 | internal event TokenBecameAvailableEventHandler{{#nullableReferenceTypes}}?{{/nullableReferenceTypes}} TokenBecameAvailable;
22 |
23 |
24 | ///
25 | /// Initialize a TokenBase object.
26 | ///
27 | ///
28 | internal TokenBase(TimeSpan? timeout = null)
29 | {
30 | Timeout = timeout;
31 |
32 | if (Timeout != null)
33 | StartTimer(Timeout.Value);
34 | }
35 |
36 |
37 | ///
38 | /// Starts the token's timer
39 | ///
40 | ///
41 | internal void StartTimer(TimeSpan timeout)
42 | {
43 | Timeout = timeout;
44 | _timer.Interval = Timeout.Value.TotalMilliseconds;
45 | _timer.Elapsed += OnTimer;
46 | _timer.AutoReset = true;
47 | _timer.Start();
48 | }
49 |
50 | ///
51 | /// Returns true while the token is rate limited.
52 | ///
53 | public bool IsRateLimited => _nextAvailable > DateTime.UtcNow;
54 |
55 | ///
56 | /// Triggered when the server returns status code TooManyRequests
57 | /// Once triggered the local timeout will be extended an arbitrary length of time.
58 | ///
59 | public void BeginRateLimit()
60 | {
61 | lock(_nextAvailableLock)
62 | _nextAvailable = DateTime.UtcNow.AddSeconds(5);
63 | }
64 |
65 | private void OnTimer(object sender, System.Timers.ElapsedEventArgs e)
66 | {
67 | if (TokenBecameAvailable != null && !IsRateLimited)
68 | TokenBecameAvailable.Invoke(this);
69 | }
70 | }
71 | }
--------------------------------------------------------------------------------
/gen/templates/libraries/generichost/TokenContainer`1.mustache:
--------------------------------------------------------------------------------
1 | //
2 | {{partial_header}}
3 | {{#nullableReferenceTypes}}#nullable enable{{/nullableReferenceTypes}}
4 |
5 | using System.Linq;
6 | using System.Collections.Generic;
7 |
8 | namespace {{packageName}}.Client
9 | {
10 | ///
11 | /// A container for a collection of tokens.
12 | ///
13 | ///
14 | public sealed class TokenContainer where TTokenBase : TokenBase
15 | {
16 | ///
17 | /// The collection of tokens
18 | ///
19 | public List Tokens { get; } = new List();
20 |
21 | ///
22 | /// Instantiates a TokenContainer
23 | ///
24 | public TokenContainer()
25 | {
26 | }
27 |
28 | ///
29 | /// Instantiates a TokenContainer
30 | ///
31 | ///
32 | public TokenContainer(System.Collections.Generic.IEnumerable tokens)
33 | {
34 | Tokens = tokens.ToList();
35 | }
36 | }
37 | }
--------------------------------------------------------------------------------
/gen/templates/libraries/generichost/TokenProvider`1.mustache:
--------------------------------------------------------------------------------
1 | //
2 | {{>partial_header}}
3 | {{#nullableReferenceTypes}}#nullable enable{{/nullableReferenceTypes}}
4 |
5 | using System;
6 | using System.Linq;
7 | using System.Collections.Generic;
8 | using {{packageName}}.Client;
9 |
10 | namespace {{packageName}}
11 | {
12 | ///
13 | /// A class which will provide tokens.
14 | ///
15 | public abstract class TokenProvider where TTokenBase : TokenBase
16 | {
17 | ///
18 | /// The array of tokens.
19 | ///
20 | protected TTokenBase[] _tokens;
21 |
22 | internal abstract System.Threading.Tasks.ValueTask GetAsync(System.Threading.CancellationToken? cancellation = null);
23 |
24 | ///
25 | /// Instantiates a TokenProvider.
26 | ///
27 | ///
28 | public TokenProvider(IEnumerable tokens)
29 | {
30 | _tokens = tokens.ToArray();
31 |
32 | if (_tokens.Length == 0)
33 | throw new ArgumentException("You did not provide any tokens.");
34 | }
35 | }
36 | }
--------------------------------------------------------------------------------
/gen/templates/libraries/generichost/api_test.mustache:
--------------------------------------------------------------------------------
1 | {{>partial_header}}
2 | using System;
3 | using System.Collections.Generic;
4 | using System.Threading.Tasks;
5 | using Xunit;
6 | using Microsoft.Extensions.DependencyInjection;
7 | using {{packageName}}.{{apiPackage}};{{#hasImport}}
8 | using {{packageName}}.{{modelPackage}};{{/hasImport}}
9 |
10 |
11 | {{{testInstructions}}}
12 |
13 |
14 | namespace {{packageName}}.Test.Api
15 | {
16 | ///
17 | /// Class for testing {{classname}}
18 | ///
19 | public sealed class {{classname}}Tests : ApiTestsBase
20 | {
21 | private readonly {{interfacePrefix}}{{classname}} _instance;
22 |
23 | public {{classname}}Tests(): base(Array.Empty())
24 | {
25 | _instance = _host.Services.GetRequiredService<{{interfacePrefix}}{{classname}}>();
26 | }
27 |
28 | {{#operations}}
29 | {{#operation}}
30 |
31 | ///
32 | /// Test {{operationId}}
33 | ///
34 | [Fact (Skip = "not implemented")]
35 | public async Task {{operationId}}AsyncTest()
36 | {
37 | {{#allParams}}
38 | {{{dataType}}} {{paramName}} = default;
39 | {{/allParams}}
40 | {{#returnType}}var response = {{/returnType}}await _instance.{{operationId}}Async({{#allParams}}{{paramName}}{{^-last}}, {{/-last}}{{/allParams}});{{#returnType}}
41 | Assert.IsType<{{{.}}}>(response);{{/returnType}}
42 | }
43 | {{/operation}}
44 | {{/operations}}
45 | }
46 | }
47 |
--------------------------------------------------------------------------------
/gen/templates/libraries/generichost/git_push.sh.mustache:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | # ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
3 | #
4 | # Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
5 |
6 | git_user_id=${1:-{{{gitUserId}}}}
7 | git_repo_id=${2:-{{{gitRepoId}}}}
8 | release_note=${3:-{{{releaseNote}}}}
9 | git_host=${4:-{{{gitHost}}}}
10 |
11 | starting_directory=$(pwd)
12 | script_root="$( cd -- "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P )"
13 | cd $script_root
14 | cd ../..
15 |
16 | if [ "$release_note" = "" ] || [ "$release_note" = "Minor update" ]; then
17 | # it seems unlikely that we would want our git commit message to be the default, so lets prompt the user
18 | echo "Please provide a commit message or press enter"
19 | read user_input
20 | release_note=$user_input
21 | if [ "$release_note" = "" ]; then
22 | release_note="no message provided"
23 | fi
24 | fi
25 |
26 | git init
27 | git add .
28 | git commit -am "$release_note"
29 | branch_name=$(git rev-parse --abbrev-ref HEAD)
30 | git_remote=$(git remote)
31 |
32 | if [ "$git_remote" = "" ]; then # git remote not defined
33 |
34 | if [ "$GIT_TOKEN" = "" ]; then
35 | echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
36 | git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
37 | else
38 | git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
39 | fi
40 |
41 | fi
42 |
43 | echo "[INFO] Pulling from https://${git_host}/${git_user_id}/${git_repo_id}.git"
44 | git pull origin $branch_name --ff-only
45 |
46 | echo "[INFO] Pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
47 | git push origin $branch_name
48 |
49 | cd $starting_directory
50 |
--------------------------------------------------------------------------------
/gen/templates/libraries/httpclient/FileParameter.mustache:
--------------------------------------------------------------------------------
1 | {{>partial_header}}
2 |
3 | using System.IO;
4 |
5 | namespace {{packageName}}.Client
6 | {
7 |
8 | ///
9 | /// Represents a File passed to the API as a Parameter, allows using different backends for files
10 | ///
11 | public class FileParameter
12 | {
13 | ///
14 | /// The filename
15 | ///
16 | public string Name { get; set; } = "no_name_provided";
17 |
18 | ///
19 | /// The content type of the file
20 | ///
21 | public string ContentType { get; set; } = "application/octet-stream";
22 |
23 | ///
24 | /// The content of the file
25 | ///
26 | public Stream Content { get; set; }
27 |
28 | ///
29 | /// Construct a FileParameter just from the contents, will extract the filename from a filestream
30 | ///
31 | /// The file content
32 | public FileParameter(Stream content)
33 | {
34 | if (content is FileStream fs)
35 | {
36 | Name = fs.Name;
37 | }
38 | Content = content;
39 | }
40 |
41 | ///
42 | /// Construct a FileParameter from name and content
43 | ///
44 | /// The filename
45 | /// The file content
46 | public FileParameter(string filename, Stream content)
47 | {
48 | Name = filename;
49 | Content = content;
50 | }
51 |
52 | ///
53 | /// Construct a FileParameter from name and content
54 | ///
55 | /// The filename
56 | /// The content type of the file
57 | /// The file content
58 | public FileParameter(string filename, string contentType, Stream content)
59 | {
60 | Name = filename;
61 | ContentType = contentType;
62 | Content = content;
63 | }
64 |
65 | ///
66 | /// Implicit conversion of stream to file parameter. Useful for backwards compatibility.
67 | ///
68 | /// Stream to convert
69 | /// FileParameter
70 | public static implicit operator FileParameter(Stream s) => new FileParameter(s);
71 | }
72 | }
--------------------------------------------------------------------------------
/gen/templates/libraries/httpclient/RequestOptions.mustache:
--------------------------------------------------------------------------------
1 | {{>partial_header}}
2 |
3 | using System;
4 | using System.Collections.Generic;
5 | using System.IO;
6 | using System.Net;
7 |
8 | namespace {{packageName}}.Client
9 | {
10 | ///
11 | /// A container for generalized request inputs. This type allows consumers to extend the request functionality
12 | /// by abstracting away from the default (built-in) request framework (e.g. RestSharp).
13 | ///
14 | public class RequestOptions
15 | {
16 | ///
17 | /// Parameters to be bound to path parts of the Request's URL
18 | ///
19 | public Dictionary PathParameters { get; set; }
20 |
21 | ///
22 | /// Query parameters to be applied to the request.
23 | /// Keys may have 1 or more values associated.
24 | ///
25 | public Multimap QueryParameters { get; set; }
26 |
27 | ///
28 | /// Header parameters to be applied to to the request.
29 | /// Keys may have 1 or more values associated.
30 | ///
31 | public Multimap HeaderParameters { get; set; }
32 |
33 | ///
34 | /// Form parameters to be sent along with the request.
35 | ///
36 | public Dictionary FormParameters { get; set; }
37 |
38 | ///
39 | /// File parameters to be sent along with the request.
40 | ///
41 | public Multimap FileParameters { get; set; }
42 |
43 | ///
44 | /// Cookies to be sent along with the request.
45 | ///
46 | public List Cookies { get; set; }
47 |
48 | ///
49 | /// Any data associated with a request body.
50 | ///
51 | public Object Data { get; set; }
52 |
53 | ///
54 | /// Constructs a new instance of
55 | ///
56 | public RequestOptions()
57 | {
58 | PathParameters = new Dictionary();
59 | QueryParameters = new Multimap();
60 | HeaderParameters = new Multimap();
61 | FormParameters = new Dictionary();
62 | FileParameters = new Multimap();
63 | Cookies = new List();
64 | }
65 | }
66 | }
67 |
--------------------------------------------------------------------------------
/gen/templates/libraries/httpclient/model.mustache:
--------------------------------------------------------------------------------
1 | {{>partial_header}}
2 |
3 | using System;
4 | using System.Collections;
5 | using System.Collections.Generic;
6 | using System.Collections.ObjectModel;
7 | using System.Linq;
8 | using System.IO;
9 | using System.Runtime.Serialization;
10 | using System.Text;
11 | using System.Text.RegularExpressions;
12 | using Newtonsoft.Json;
13 | using Newtonsoft.Json.Converters;
14 | using Newtonsoft.Json.Linq;
15 | {{#models}}
16 | {{#model}}
17 | {{#discriminator}}
18 | using JsonSubTypes;
19 | {{/discriminator}}
20 | {{/model}}
21 | {{/models}}
22 | {{#validatable}}
23 | using System.ComponentModel.DataAnnotations;
24 | {{/validatable}}
25 | using FileParameter = {{packageName}}.Client.FileParameter;
26 | using OpenAPIDateConverter = {{packageName}}.Client.OpenAPIDateConverter;
27 | {{#useCompareNetObjects}}
28 | using OpenAPIClientUtils = {{packageName}}.Client.ClientUtils;
29 | {{/useCompareNetObjects}}
30 | {{#models}}
31 | {{#model}}
32 | {{#oneOf}}
33 | {{#-first}}
34 | using System.Reflection;
35 | {{/-first}}
36 | {{/oneOf}}
37 | {{#aneOf}}
38 | {{#-first}}
39 | using System.Reflection;
40 | {{/-first}}
41 | {{/aneOf}}
42 |
43 | namespace {{packageName}}.{{modelPackage}}
44 | {
45 | {{#isEnum}}{{>modelEnum}}{{/isEnum}}{{^isEnum}}{{#oneOf}}{{#-first}}{{>modelOneOf}}{{/-first}}{{/oneOf}}{{#anyOf}}{{#-first}}{{>modelAnyOf}}{{/-first}}{{/anyOf}}{{^oneOf}}{{^anyOf}}{{>modelGeneric}}{{/anyOf}}{{/oneOf}}{{/isEnum}}
46 | {{/model}}
47 | {{/models}}
48 | }
49 |
--------------------------------------------------------------------------------
/gen/templates/model.mustache:
--------------------------------------------------------------------------------
1 | {{>partial_header}}
2 |
3 | using System;
4 | using System.Collections;
5 | using System.Collections.Generic;
6 | using System.Collections.ObjectModel;
7 | using System.Linq;
8 | using System.IO;
9 | using System.Runtime.Serialization;
10 | using System.Text;
11 | using System.Text.RegularExpressions;
12 | using Newtonsoft.Json;
13 | using Newtonsoft.Json.Converters;
14 | using Newtonsoft.Json.Linq;
15 | {{#models}}
16 | {{#model}}
17 | {{#discriminator}}
18 | using JsonSubTypes;
19 | {{/discriminator}}
20 | {{/model}}
21 | {{/models}}
22 | {{#validatable}}
23 | using System.ComponentModel.DataAnnotations;
24 | {{/validatable}}
25 | using OpenAPIDateConverter = {{packageName}}.Client.OpenAPIDateConverter;
26 | {{#useCompareNetObjects}}
27 | using OpenAPIClientUtils = {{packageName}}.Client.ClientUtils;
28 | {{/useCompareNetObjects}}
29 | {{#models}}
30 | {{#model}}
31 | {{#oneOf}}
32 | {{#-first}}
33 | using System.Reflection;
34 | {{/-first}}
35 | {{/oneOf}}
36 | {{#aneOf}}
37 | {{#-first}}
38 | using System.Reflection;
39 | {{/-first}}
40 | {{/aneOf}}
41 |
42 | namespace {{packageName}}.{{modelPackage}}
43 | {
44 | {{#isEnum}}{{>modelEnum}}{{/isEnum}}{{^isEnum}}{{#oneOf}}{{#-first}}{{>modelOneOf}}{{/-first}}{{/oneOf}}{{#anyOf}}{{#-first}}{{>modelAnyOf}}{{/-first}}{{/anyOf}}{{^oneOf}}{{^anyOf}}{{>modelGeneric}}{{/anyOf}}{{/oneOf}}{{/isEnum}}
45 | {{/model}}
46 | {{/models}}
47 | }
48 |
--------------------------------------------------------------------------------
/gen/templates/modelEnum.mustache:
--------------------------------------------------------------------------------
1 | ///
2 | /// {{description}}{{^description}}Defines {{{name}}}{{/description}}
3 | ///
4 | {{#description}}
5 | /// {{.}}
6 | {{/description}}
7 | {{#allowableValues}}
8 | {{#enumVars}}
9 | {{#-first}}
10 | {{#isString}}
11 | [JsonConverter(typeof(StringEnumConverter))]
12 | {{/isString}}
13 | {{/-first}}
14 | {{/enumVars}}
15 | {{/allowableValues}}
16 | {{>visibility}} enum {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}{{#vendorExtensions.x-enum-byte}}: byte{{/vendorExtensions.x-enum-byte}}
17 | {
18 | {{#allowableValues}}
19 | {{#enumVars}}
20 | ///
21 | /// Enum {{name}} for value: {{value}}
22 | ///
23 | {{#isString}}
24 | [EnumMember(Value = "{{{value}}}")]
25 | {{/isString}}
26 | {{name}}{{^isString}} = {{{value}}}{{/isString}}{{#isString}} = {{-index}}{{/isString}}{{^-last}},{{/-last}}
27 |
28 | {{/enumVars}}
29 | {{/allowableValues}}
30 | }{{! NOTE: This model's enumVars is modified to look like CodegenProperty}}
31 |
--------------------------------------------------------------------------------
/gen/templates/modelInnerEnum.mustache:
--------------------------------------------------------------------------------
1 | {{^isContainer}}
2 | ///
3 | /// {{description}}{{^description}}Defines {{{name}}}{{/description}}
4 | ///
5 | {{#description}}
6 | /// {{.}}
7 | {{/description}}
8 | {{#isString}}
9 | [JsonConverter(typeof(StringEnumConverter))]
10 | {{/isString}}
11 | {{>visibility}} enum {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}{{#vendorExtensions.x-enum-byte}}: byte{{/vendorExtensions.x-enum-byte}}
12 | {
13 | {{#allowableValues}}
14 | {{#enumVars}}
15 | ///
16 | /// Enum {{name}} for value: {{value}}
17 | ///
18 | {{#isString}}
19 | [EnumMember(Value = "{{{value}}}")]
20 | {{/isString}}
21 | {{name}}{{^isString}} = {{{value}}}{{/isString}}{{#isString}} = {{-index}}{{/isString}}{{^-last}},{{/-last}}
22 |
23 | {{/enumVars}}
24 | {{/allowableValues}}
25 | }
26 | {{/isContainer}}
27 |
--------------------------------------------------------------------------------
/gen/templates/model_doc.mustache:
--------------------------------------------------------------------------------
1 | {{#models}}
2 | {{#model}}
3 | # {{{packageName}}}.{{modelPackage}}.{{{classname}}}
4 | {{#description}}{{&description}}
5 | {{/description}}
6 |
7 | ## Properties
8 |
9 | Name | Type | Description | Notes
10 | ------------ | ------------- | ------------- | -------------
11 | {{#parent}}
12 | {{#parentVars}}
13 | **{{name}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{dataType}}**]({{complexType}}.md){{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#isReadOnly}}[readonly] {{/isReadOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}
14 | {{/parentVars}}
15 | {{/parent}}
16 | {{#vars}}**{{name}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{dataType}}**]({{complexType}}.md){{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#isReadOnly}}[readonly] {{/isReadOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}
17 | {{/vars}}
18 |
19 | [[Back to Model list]](../{{#useGenericHost}}../{{/useGenericHost}}README.md#documentation-for-models) [[Back to API list]](../{{#useGenericHost}}../{{/useGenericHost}}README.md#documentation-for-api-endpoints) [[Back to README]](../{{#useGenericHost}}../{{/useGenericHost}}README.md)
20 |
21 | {{/model}}
22 | {{/models}}
23 |
--------------------------------------------------------------------------------
/gen/templates/model_test.mustache:
--------------------------------------------------------------------------------
1 | {{>partial_header}}
2 |
3 | using Xunit;
4 |
5 | using System;
6 | using System.Linq;
7 | using System.IO;
8 | using System.Collections.Generic;
9 | using {{packageName}}.{{apiPackage}};
10 | using {{packageName}}.{{modelPackage}};
11 | using {{packageName}}.Client;
12 | using System.Reflection;
13 | using Newtonsoft.Json;
14 |
15 | {{#models}}
16 | {{#model}}
17 | namespace {{packageName}}.Test.Model
18 | {
19 | ///
20 | /// Class for testing {{classname}}
21 | ///
22 | ///
23 | /// This file is automatically generated by OpenAPI Generator (https://openapi-generator.tech).
24 | /// Please update the test case below to test the model.
25 | ///
26 | public class {{classname}}Tests : IDisposable
27 | {
28 | // TODO uncomment below to declare an instance variable for {{classname}}
29 | //private {{classname}} instance;
30 |
31 | public {{classname}}Tests()
32 | {
33 | // TODO uncomment below to create an instance of {{classname}}
34 | //instance = new {{classname}}();
35 | }
36 |
37 | public void Dispose()
38 | {
39 | // Cleanup when everything is done.
40 | }
41 |
42 | ///
43 | /// Test an instance of {{classname}}
44 | ///
45 | [Fact]
46 | public void {{classname}}InstanceTest()
47 | {
48 | // TODO uncomment below to test "IsType" {{classname}}
49 | //Assert.IsType<{{classname}}>(instance);
50 | }
51 |
52 | {{#discriminator}}
53 | {{#children}}
54 | ///
55 | /// Test deserialize a {{classname}} from type {{parent}}
56 | ///
57 | [Fact]
58 | public void {{classname}}DeserializeFrom{{parent}}Test()
59 | {
60 | // TODO uncomment below to test deserialize a {{classname}} from type {{parent}}
61 | //Assert.IsType<{{parent}}>(JsonConvert.DeserializeObject<{{parent}}>(new {{classname}}().ToJson()));
62 | }
63 | {{/children}}
64 | {{/discriminator}}
65 |
66 | {{#vars}}
67 | ///
68 | /// Test the property '{{name}}'
69 | ///
70 | [Fact]
71 | public void {{name}}Test()
72 | {
73 | // TODO unit test for the property '{{name}}'
74 | }
75 | {{/vars}}
76 |
77 | }
78 |
79 | }
80 | {{/model}}
81 | {{/models}}
82 |
--------------------------------------------------------------------------------
/gen/templates/netcore_testproject.mustache:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | {{testPackageName}}
5 | {{testPackageName}}
6 | {{testTargetFramework}}
7 | false{{#nullableReferenceTypes}}
8 | annotations{{/nullableReferenceTypes}}
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
--------------------------------------------------------------------------------
/gen/templates/nuspec.mustache:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | $id$
6 | {{packageTitle}}
7 |
8 |
9 | $version$
10 |
11 |
12 | $author$
13 |
14 |
16 | $author$
17 | false
18 | false
19 |
20 |
22 | {{packageDescription}}
23 | {{#termsOfService}}
24 | {{.}}
25 | {{/termsOfService}}
26 | {{#licenseUrl}}
27 | {{.}}
28 | {{/licenseUrl}}
29 |
30 |
31 |
32 |
33 |
34 | {{#useRestSharp}}
35 |
36 | {{/useRestSharp}}
37 | {{#useCompareNetObjects}}
38 |
39 | {{/useCompareNetObjects}}
40 |
41 | {{#validatable}}
42 |
43 | {{/validatable}}
44 | {{#supportsRetry}}
45 |
46 | {{/supportsRetry}}
47 |
48 |
49 |
50 |
51 |
52 |
53 |
54 |
55 |
56 |
57 |
58 |
--------------------------------------------------------------------------------
/gen/templates/partial_header.mustache:
--------------------------------------------------------------------------------
1 | /*
2 | {{#appName}}
3 | * {{{.}}}
4 | *
5 | {{/appName}}
6 | {{#appDescription}}
7 | * {{{.}}}
8 | *
9 | {{/appDescription}}
10 | {{#version}}
11 | * The version of the OpenAPI document: {{{.}}}
12 | {{/version}}
13 | {{#infoEmail}}
14 | * Contact: {{{.}}}
15 | {{/infoEmail}}
16 | * Generated by: https://github.com/openapitools/openapi-generator.git
17 | */
18 |
--------------------------------------------------------------------------------
/gen/templates/visibility.mustache:
--------------------------------------------------------------------------------
1 | {{#nonPublicApi}}internal{{/nonPublicApi}}{{^nonPublicApi}}public{{/nonPublicApi}}
--------------------------------------------------------------------------------
/icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/muxinc/mux-csharp/d2fe110a6696eb927ebf58b2536033b536fbc889/icon.png
--------------------------------------------------------------------------------
/src/Mux.Csharp.Sdk.Test/Mux.Csharp.Sdk.Test.csproj:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Mux.Csharp.Sdk.Test
5 | Mux.Csharp.Sdk.Test
6 | netcoreapp3.1
7 | false
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
--------------------------------------------------------------------------------
/src/Mux.Csharp.Sdk.Test/TestHelpers.cs:
--------------------------------------------------------------------------------
1 | using System;
2 |
3 | using Mux.Csharp.Sdk.Client;
4 |
5 | internal static class TestHelpers {
6 | public static Configuration BuildApiConfiguration() {
7 | return new Configuration() {
8 | BasePath = "https://api.mux.com",
9 | Username = Environment.GetEnvironmentVariable("MUX_TOKEN_ID"),
10 | Password = Environment.GetEnvironmentVariable("MUX_TOKEN_SECRET")
11 | };
12 | }
13 | }
--------------------------------------------------------------------------------
/src/Mux.Csharp.Sdk/Client/ExceptionFactory.cs:
--------------------------------------------------------------------------------
1 | /*
2 | * Mux API
3 | *
4 | * 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.
5 | *
6 | * The version of the OpenAPI document: v1
7 | * Contact: devex@mux.com
8 | * Generated by: https://github.com/openapitools/openapi-generator.git
9 | */
10 |
11 |
12 | using System;
13 |
14 | namespace Mux.Csharp.Sdk.Client
15 | {
16 | ///
17 | /// A delegate to ExceptionFactory method
18 | ///
19 | /// Method name
20 | /// Response
21 | /// Exceptions
22 | public delegate Exception ExceptionFactory(string methodName, IApiResponse response);
23 | }
24 |
--------------------------------------------------------------------------------
/src/Mux.Csharp.Sdk/Client/GlobalConfiguration.cs:
--------------------------------------------------------------------------------
1 | /*
2 | * Mux API
3 | *
4 | * 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.
5 | *
6 | * The version of the OpenAPI document: v1
7 | * Contact: devex@mux.com
8 | * Generated by: https://github.com/openapitools/openapi-generator.git
9 | */
10 |
11 |
12 | using System.Collections.Generic;
13 |
14 | namespace Mux.Csharp.Sdk.Client
15 | {
16 | ///
17 | /// provides a compile-time extension point for globally configuring
18 | /// API Clients.
19 | ///
20 | ///
21 | /// A customized implementation via partial class may reside in another file and may
22 | /// be excluded from automatic generation via a .openapi-generator-ignore file.
23 | ///
24 | public partial class GlobalConfiguration : Configuration
25 | {
26 | #region Private Members
27 |
28 | private static readonly object GlobalConfigSync = new { };
29 | private static IReadableConfiguration _globalConfiguration;
30 |
31 | #endregion Private Members
32 |
33 | #region Constructors
34 |
35 | ///
36 | private GlobalConfiguration()
37 | {
38 | }
39 |
40 | ///
41 | public GlobalConfiguration(IDictionary defaultHeader, IDictionary apiKey, IDictionary apiKeyPrefix, string basePath = "http://localhost:3000/api") : base(defaultHeader, apiKey, apiKeyPrefix, basePath)
42 | {
43 | }
44 |
45 | static GlobalConfiguration()
46 | {
47 | Instance = new GlobalConfiguration();
48 | }
49 |
50 | #endregion Constructors
51 |
52 | ///
53 | /// Gets or sets the default Configuration.
54 | ///
55 | /// Configuration.
56 | public static IReadableConfiguration Instance
57 | {
58 | get { return _globalConfiguration; }
59 | set
60 | {
61 | lock (GlobalConfigSync)
62 | {
63 | _globalConfiguration = value;
64 | }
65 | }
66 | }
67 | }
68 | }
69 |
--------------------------------------------------------------------------------
/src/Mux.Csharp.Sdk/Client/HttpMethod.cs:
--------------------------------------------------------------------------------
1 | /*
2 | * Mux API
3 | *
4 | * 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.
5 | *
6 | * The version of the OpenAPI document: v1
7 | * Contact: devex@mux.com
8 | * Generated by: https://github.com/openapitools/openapi-generator.git
9 | */
10 |
11 |
12 | namespace Mux.Csharp.Sdk.Client
13 | {
14 | ///
15 | /// Http methods supported by swagger
16 | ///
17 | public enum HttpMethod
18 | {
19 | /// HTTP GET request.
20 | Get,
21 | /// HTTP POST request.
22 | Post,
23 | /// HTTP PUT request.
24 | Put,
25 | /// HTTP DELETE request.
26 | Delete,
27 | /// HTTP HEAD request.
28 | Head,
29 | /// HTTP OPTIONS request.
30 | Options,
31 | /// HTTP PATCH request.
32 | Patch
33 | }
34 | }
35 |
--------------------------------------------------------------------------------
/src/Mux.Csharp.Sdk/Client/IApiAccessor.cs:
--------------------------------------------------------------------------------
1 | /*
2 | * Mux API
3 | *
4 | * 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.
5 | *
6 | * The version of the OpenAPI document: v1
7 | * Contact: devex@mux.com
8 | * Generated by: https://github.com/openapitools/openapi-generator.git
9 | */
10 |
11 |
12 | using System;
13 |
14 | namespace Mux.Csharp.Sdk.Client
15 | {
16 | ///
17 | /// Represents configuration aspects required to interact with the API endpoints.
18 | ///
19 | public interface IApiAccessor
20 | {
21 | ///
22 | /// Gets or sets the configuration object
23 | ///
24 | /// An instance of the Configuration
25 | IReadableConfiguration Configuration { get; set; }
26 |
27 | ///
28 | /// Gets the base path of the API client.
29 | ///
30 | /// The base path
31 | string GetBasePath();
32 |
33 | ///
34 | /// Provides a factory method hook for the creation of exceptions.
35 | ///
36 | ExceptionFactory ExceptionFactory { get; set; }
37 | }
38 | }
39 |
--------------------------------------------------------------------------------
/src/Mux.Csharp.Sdk/Client/OpenAPIDateConverter.cs:
--------------------------------------------------------------------------------
1 | /*
2 | * Mux API
3 | *
4 | * 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.
5 | *
6 | * The version of the OpenAPI document: v1
7 | * Contact: devex@mux.com
8 | * Generated by: https://github.com/openapitools/openapi-generator.git
9 | */
10 |
11 | using Newtonsoft.Json.Converters;
12 |
13 | namespace Mux.Csharp.Sdk.Client
14 | {
15 | ///
16 | /// Formatter for 'date' openapi formats ss defined by full-date - RFC3339
17 | /// see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#data-types
18 | ///
19 | public class OpenAPIDateConverter : IsoDateTimeConverter
20 | {
21 | ///
22 | /// Initializes a new instance of the class.
23 | ///
24 | public OpenAPIDateConverter()
25 | {
26 | // full-date = date-fullyear "-" date-month "-" date-mday
27 | DateTimeFormat = "yyyy-MM-dd";
28 | }
29 | }
30 | }
31 |
--------------------------------------------------------------------------------
/src/Mux.Csharp.Sdk/Client/RetryConfiguration.cs:
--------------------------------------------------------------------------------
1 | /*
2 | * Mux API
3 | *
4 | * 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.
5 | *
6 | * The version of the OpenAPI document: v1
7 | * Contact: devex@mux.com
8 | * Generated by: https://github.com/openapitools/openapi-generator.git
9 | */
10 |
11 |
12 | using Polly;
13 | using RestSharp;
14 |
15 | namespace Mux.Csharp.Sdk.Client
16 | {
17 | ///
18 | /// Configuration class to set the polly retry policies to be applied to the requests.
19 | ///
20 | public static class RetryConfiguration
21 | {
22 | ///
23 | /// Retry policy
24 | ///
25 | public static Policy RetryPolicy { get; set; }
26 |
27 | ///
28 | /// Async retry policy
29 | ///
30 | public static AsyncPolicy AsyncRetryPolicy { get; set; }
31 | }
32 | }
33 |
--------------------------------------------------------------------------------
/src/Mux.Csharp.Sdk/Model/BroadcastLayout.cs:
--------------------------------------------------------------------------------
1 | /*
2 | * Mux API
3 | *
4 | * 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.
5 | *
6 | * The version of the OpenAPI document: v1
7 | * Contact: devex@mux.com
8 | * Generated by: https://github.com/openapitools/openapi-generator.git
9 | */
10 |
11 |
12 | using System;
13 | using System.Collections;
14 | using System.Collections.Generic;
15 | using System.Collections.ObjectModel;
16 | using System.Linq;
17 | using System.IO;
18 | using System.Runtime.Serialization;
19 | using System.Text;
20 | using System.Text.RegularExpressions;
21 | using Newtonsoft.Json;
22 | using Newtonsoft.Json.Converters;
23 | using Newtonsoft.Json.Linq;
24 | using System.ComponentModel.DataAnnotations;
25 | using OpenAPIDateConverter = Mux.Csharp.Sdk.Client.OpenAPIDateConverter;
26 |
27 | namespace Mux.Csharp.Sdk.Model
28 | {
29 | ///
30 | /// The layout used when broadcasting the space. The `gallery` layout will show participants in a grid that automatically resizes each participant’s stream to best fit up to 10 participants in the window. The `active-speaker` layout will show only the current active speaker, without a border. The `crop` layout uses as much of the available space as possible to show the participant's stream. Defaults to `gallery` if not set.
31 | ///
32 | /// The layout used when broadcasting the space. The `gallery` layout will show participants in a grid that automatically resizes each participant’s stream to best fit up to 10 participants in the window. The `active-speaker` layout will show only the current active speaker, without a border. The `crop` layout uses as much of the available space as possible to show the participant's stream. Defaults to `gallery` if not set.
33 | [JsonConverter(typeof(StringEnumConverter))]
34 | public enum BroadcastLayout
35 | {
36 | ///
37 | /// Enum Gallery for value: gallery
38 | ///
39 | [EnumMember(Value = "gallery")]
40 | Gallery = 1,
41 |
42 | ///
43 | /// Enum ActiveSpeaker for value: active-speaker
44 | ///
45 | [EnumMember(Value = "active-speaker")]
46 | ActiveSpeaker = 2,
47 |
48 | ///
49 | /// Enum Crop for value: crop
50 | ///
51 | [EnumMember(Value = "crop")]
52 | Crop = 3
53 |
54 | }
55 |
56 | }
57 |
--------------------------------------------------------------------------------
/src/Mux.Csharp.Sdk/Model/BroadcastResolution.cs:
--------------------------------------------------------------------------------
1 | /*
2 | * Mux API
3 | *
4 | * 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.
5 | *
6 | * The version of the OpenAPI document: v1
7 | * Contact: devex@mux.com
8 | * Generated by: https://github.com/openapitools/openapi-generator.git
9 | */
10 |
11 |
12 | using System;
13 | using System.Collections;
14 | using System.Collections.Generic;
15 | using System.Collections.ObjectModel;
16 | using System.Linq;
17 | using System.IO;
18 | using System.Runtime.Serialization;
19 | using System.Text;
20 | using System.Text.RegularExpressions;
21 | using Newtonsoft.Json;
22 | using Newtonsoft.Json.Converters;
23 | using Newtonsoft.Json.Linq;
24 | using System.ComponentModel.DataAnnotations;
25 | using OpenAPIDateConverter = Mux.Csharp.Sdk.Client.OpenAPIDateConverter;
26 |
27 | namespace Mux.Csharp.Sdk.Model
28 | {
29 | ///
30 | /// The resolution of the composited video sent to the live stream. Defaults to `1920x1080` if not set.
31 | ///
32 | /// The resolution of the composited video sent to the live stream. Defaults to `1920x1080` if not set.
33 | [JsonConverter(typeof(StringEnumConverter))]
34 | public enum BroadcastResolution
35 | {
36 | ///
37 | /// Enum _1920x1080 for value: 1920x1080
38 | ///
39 | [EnumMember(Value = "1920x1080")]
40 | _1920x1080 = 1,
41 |
42 | ///
43 | /// Enum _1280x720 for value: 1280x720
44 | ///
45 | [EnumMember(Value = "1280x720")]
46 | _1280x720 = 2,
47 |
48 | ///
49 | /// Enum _1080x1920 for value: 1080x1920
50 | ///
51 | [EnumMember(Value = "1080x1920")]
52 | _1080x1920 = 3,
53 |
54 | ///
55 | /// Enum _720x1280 for value: 720x1280
56 | ///
57 | [EnumMember(Value = "720x1280")]
58 | _720x1280 = 4,
59 |
60 | ///
61 | /// Enum _1080x1080 for value: 1080x1080
62 | ///
63 | [EnumMember(Value = "1080x1080")]
64 | _1080x1080 = 5,
65 |
66 | ///
67 | /// Enum _720x720 for value: 720x720
68 | ///
69 | [EnumMember(Value = "720x720")]
70 | _720x720 = 6
71 |
72 | }
73 |
74 | }
75 |
--------------------------------------------------------------------------------
/src/Mux.Csharp.Sdk/Model/BroadcastStatus.cs:
--------------------------------------------------------------------------------
1 | /*
2 | * Mux API
3 | *
4 | * 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.
5 | *
6 | * The version of the OpenAPI document: v1
7 | * Contact: devex@mux.com
8 | * Generated by: https://github.com/openapitools/openapi-generator.git
9 | */
10 |
11 |
12 | using System;
13 | using System.Collections;
14 | using System.Collections.Generic;
15 | using System.Collections.ObjectModel;
16 | using System.Linq;
17 | using System.IO;
18 | using System.Runtime.Serialization;
19 | using System.Text;
20 | using System.Text.RegularExpressions;
21 | using Newtonsoft.Json;
22 | using Newtonsoft.Json.Converters;
23 | using Newtonsoft.Json.Linq;
24 | using System.ComponentModel.DataAnnotations;
25 | using OpenAPIDateConverter = Mux.Csharp.Sdk.Client.OpenAPIDateConverter;
26 |
27 | namespace Mux.Csharp.Sdk.Model
28 | {
29 | ///
30 | /// The status of the broadcast. You can start and stop broadcasts with the `start` and `stop` APIs.
31 | ///
32 | /// The status of the broadcast. You can start and stop broadcasts with the `start` and `stop` APIs.
33 | [JsonConverter(typeof(StringEnumConverter))]
34 | public enum BroadcastStatus
35 | {
36 | ///
37 | /// Enum Idle for value: idle
38 | ///
39 | [EnumMember(Value = "idle")]
40 | Idle = 1,
41 |
42 | ///
43 | /// Enum Active for value: active
44 | ///
45 | [EnumMember(Value = "active")]
46 | Active = 2
47 |
48 | }
49 |
50 | }
51 |
--------------------------------------------------------------------------------
/src/Mux.Csharp.Sdk/Model/LiveStreamStatus.cs:
--------------------------------------------------------------------------------
1 | /*
2 | * Mux API
3 | *
4 | * 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.
5 | *
6 | * The version of the OpenAPI document: v1
7 | * Contact: devex@mux.com
8 | * Generated by: https://github.com/openapitools/openapi-generator.git
9 | */
10 |
11 |
12 | using System;
13 | using System.Collections;
14 | using System.Collections.Generic;
15 | using System.Collections.ObjectModel;
16 | using System.Linq;
17 | using System.IO;
18 | using System.Runtime.Serialization;
19 | using System.Text;
20 | using System.Text.RegularExpressions;
21 | using Newtonsoft.Json;
22 | using Newtonsoft.Json.Converters;
23 | using Newtonsoft.Json.Linq;
24 | using System.ComponentModel.DataAnnotations;
25 | using OpenAPIDateConverter = Mux.Csharp.Sdk.Client.OpenAPIDateConverter;
26 |
27 | namespace Mux.Csharp.Sdk.Model
28 | {
29 | ///
30 | /// `idle` indicates that there is no active broadcast. `active` indicates that there is an active broadcast and `disabled` status indicates that no future RTMP streams can be published.
31 | ///
32 | /// `idle` indicates that there is no active broadcast. `active` indicates that there is an active broadcast and `disabled` status indicates that no future RTMP streams can be published.
33 | [JsonConverter(typeof(StringEnumConverter))]
34 | public enum LiveStreamStatus
35 | {
36 | ///
37 | /// Enum Active for value: active
38 | ///
39 | [EnumMember(Value = "active")]
40 | Active = 1,
41 |
42 | ///
43 | /// Enum Idle for value: idle
44 | ///
45 | [EnumMember(Value = "idle")]
46 | Idle = 2,
47 |
48 | ///
49 | /// Enum Disabled for value: disabled
50 | ///
51 | [EnumMember(Value = "disabled")]
52 | Disabled = 3
53 |
54 | }
55 |
56 | }
57 |
--------------------------------------------------------------------------------
/src/Mux.Csharp.Sdk/Model/SpaceStatus.cs:
--------------------------------------------------------------------------------
1 | /*
2 | * Mux API
3 | *
4 | * 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.
5 | *
6 | * The version of the OpenAPI document: v1
7 | * Contact: devex@mux.com
8 | * Generated by: https://github.com/openapitools/openapi-generator.git
9 | */
10 |
11 |
12 | using System;
13 | using System.Collections;
14 | using System.Collections.Generic;
15 | using System.Collections.ObjectModel;
16 | using System.Linq;
17 | using System.IO;
18 | using System.Runtime.Serialization;
19 | using System.Text;
20 | using System.Text.RegularExpressions;
21 | using Newtonsoft.Json;
22 | using Newtonsoft.Json.Converters;
23 | using Newtonsoft.Json.Linq;
24 | using System.ComponentModel.DataAnnotations;
25 | using OpenAPIDateConverter = Mux.Csharp.Sdk.Client.OpenAPIDateConverter;
26 |
27 | namespace Mux.Csharp.Sdk.Model
28 | {
29 | ///
30 | /// The status of the space. Spaces are `idle` when there are no participants connected, and `active` when there are participants connected.
31 | ///
32 | /// The status of the space. Spaces are `idle` when there are no participants connected, and `active` when there are participants connected.
33 | [JsonConverter(typeof(StringEnumConverter))]
34 | public enum SpaceStatus
35 | {
36 | ///
37 | /// Enum Idle for value: idle
38 | ///
39 | [EnumMember(Value = "idle")]
40 | Idle = 1,
41 |
42 | ///
43 | /// Enum Active for value: active
44 | ///
45 | [EnumMember(Value = "active")]
46 | Active = 2
47 |
48 | }
49 |
50 | }
51 |
--------------------------------------------------------------------------------
/src/Mux.Csharp.Sdk/Model/SpaceType.cs:
--------------------------------------------------------------------------------
1 | /*
2 | * Mux API
3 | *
4 | * 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.
5 | *
6 | * The version of the OpenAPI document: v1
7 | * Contact: devex@mux.com
8 | * Generated by: https://github.com/openapitools/openapi-generator.git
9 | */
10 |
11 |
12 | using System;
13 | using System.Collections;
14 | using System.Collections.Generic;
15 | using System.Collections.ObjectModel;
16 | using System.Linq;
17 | using System.IO;
18 | using System.Runtime.Serialization;
19 | using System.Text;
20 | using System.Text.RegularExpressions;
21 | using Newtonsoft.Json;
22 | using Newtonsoft.Json.Converters;
23 | using Newtonsoft.Json.Linq;
24 | using System.ComponentModel.DataAnnotations;
25 | using OpenAPIDateConverter = Mux.Csharp.Sdk.Client.OpenAPIDateConverter;
26 |
27 | namespace Mux.Csharp.Sdk.Model
28 | {
29 | ///
30 | /// Specify the network architecture of the space. In `server` spaces, all video travels through Mux's video infrastructure. Defaults to `server` if not set.
31 | ///
32 | /// Specify the network architecture of the space. In `server` spaces, all video travels through Mux's video infrastructure. Defaults to `server` if not set.
33 | [JsonConverter(typeof(StringEnumConverter))]
34 | public enum SpaceType
35 | {
36 | ///
37 | /// Enum Server for value: server
38 | ///
39 | [EnumMember(Value = "server")]
40 | Server = 1
41 |
42 | }
43 |
44 | }
45 |
--------------------------------------------------------------------------------
/src/Mux.Csharp.Sdk/Mux.Csharp.Sdk.csproj:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | false
5 | netstandard2.0
6 | Mux.Csharp.Sdk
7 | Mux.Csharp.Sdk
8 | Library
9 | Mux DevEx Team
10 | Mux
11 | Mux SDK for .NET Core
12 | The Mux API SDK for .NET Framework and .NET Core. Check https://github.com/muxinc/mux-csharp for release notes and visit https://docs.mux.com for details on using Mux.
13 | (C) 2023 Mux, Inc.
14 | Mux.Csharp.Sdk
15 | 2.0.1
16 | bin\$(Configuration)\$(TargetFramework)\Mux.Csharp.Sdk.xml
17 | https://github.com/GIT_USER_ID/GIT_REPO_ID.git
18 | git
19 | Check https://github.com/muxinc/mux-csharp for release notes.
20 | icon.png
21 | README.md
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
--------------------------------------------------------------------------------
/src/Mux.Csharp.Sdk/icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/muxinc/mux-csharp/d2fe110a6696eb927ebf58b2536033b536fbc889/src/Mux.Csharp.Sdk/icon.png
--------------------------------------------------------------------------------