Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

v0.7.0 #7

Merged
merged 1 commit into from
Oct 13, 2023
Merged

v0.7.0 #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .openapi-generator/FILES
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ build.gradle
docs/AbridgedVideoView.md
docs/Asset.md
docs/AssetErrors.md
docs/AssetGeneratedSubtitleSettings.md
docs/AssetMaster.md
docs/AssetNonStandardInputReasons.md
docs/AssetRecordingTimes.md
Expand Down Expand Up @@ -52,6 +53,7 @@ docs/GetAssetPlaybackIDResponse.md
docs/GetLiveStreamPlaybackIDResponse.md
docs/GetMetricTimeseriesDataResponse.md
docs/GetMonitoringBreakdownResponse.md
docs/GetMonitoringBreakdownTimeseriesResponse.md
docs/GetMonitoringHistogramTimeseriesResponse.md
docs/GetMonitoringHistogramTimeseriesResponseMeta.md
docs/GetMonitoringTimeseriesResponse.md
Expand Down Expand Up @@ -108,6 +110,8 @@ docs/LiveStreamsApi.md
docs/Metric.md
docs/MetricsApi.md
docs/MonitoringApi.md
docs/MonitoringBreakdownTimeseriesDatapoint.md
docs/MonitoringBreakdownTimeseriesValues.md
docs/MonitoringBreakdownValue.md
docs/MonitoringHistogramTimeseriesBucket.md
docs/MonitoringHistogramTimeseriesBucketValues.md
Expand Down Expand Up @@ -207,6 +211,7 @@ src/main/java/com/mux/sdk/VideoViewsApi.java
src/main/java/com/mux/sdk/models/AbridgedVideoView.java
src/main/java/com/mux/sdk/models/Asset.java
src/main/java/com/mux/sdk/models/AssetErrors.java
src/main/java/com/mux/sdk/models/AssetGeneratedSubtitleSettings.java
src/main/java/com/mux/sdk/models/AssetMaster.java
src/main/java/com/mux/sdk/models/AssetNonStandardInputReasons.java
src/main/java/com/mux/sdk/models/AssetRecordingTimes.java
Expand Down Expand Up @@ -248,6 +253,7 @@ src/main/java/com/mux/sdk/models/GetAssetPlaybackIDResponse.java
src/main/java/com/mux/sdk/models/GetLiveStreamPlaybackIDResponse.java
src/main/java/com/mux/sdk/models/GetMetricTimeseriesDataResponse.java
src/main/java/com/mux/sdk/models/GetMonitoringBreakdownResponse.java
src/main/java/com/mux/sdk/models/GetMonitoringBreakdownTimeseriesResponse.java
src/main/java/com/mux/sdk/models/GetMonitoringHistogramTimeseriesResponse.java
src/main/java/com/mux/sdk/models/GetMonitoringHistogramTimeseriesResponseMeta.java
src/main/java/com/mux/sdk/models/GetMonitoringTimeseriesResponse.java
Expand Down Expand Up @@ -300,6 +306,8 @@ src/main/java/com/mux/sdk/models/LiveStreamGeneratedSubtitleSettings.java
src/main/java/com/mux/sdk/models/LiveStreamResponse.java
src/main/java/com/mux/sdk/models/LiveStreamStatus.java
src/main/java/com/mux/sdk/models/Metric.java
src/main/java/com/mux/sdk/models/MonitoringBreakdownTimeseriesDatapoint.java
src/main/java/com/mux/sdk/models/MonitoringBreakdownTimeseriesValues.java
src/main/java/com/mux/sdk/models/MonitoringBreakdownValue.java
src/main/java/com/mux/sdk/models/MonitoringHistogramTimeseriesBucket.java
src/main/java/com/mux/sdk/models/MonitoringHistogramTimeseriesBucketValues.java
Expand Down
11 changes: 8 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Add this dependency to your project's POM:
<dependency>
<groupId>com.mux</groupId>
<artifactId>mux-sdk-java</artifactId>
<version>0.6.3</version>
<version>0.7.0</version>
<scope>compile</scope>
</dependency>
```
Expand All @@ -58,7 +58,7 @@ Add this dependency to your project's POM:
Add this dependency to your project's build file:

```groovy
compile "com.mux:mux-sdk-java:0.6.3"
compile "com.mux:mux-sdk-java:0.7.0"
```

### Others
Expand All @@ -71,7 +71,7 @@ mvn clean package

Then manually install the following JARs:

* `target/mux-sdk-java-0.6.3.jar`
* `target/mux-sdk-java-0.7.0.jar`
* `target/lib/*.jar`

## Getting Started
Expand Down Expand Up @@ -173,6 +173,7 @@ Class | Method | HTTP request | Description
*MetricsApi* | [**listBreakdownValues**](docs/MetricsApi.md#listBreakdownValues) | **GET** /data/v1/metrics/{METRIC_ID}/breakdown | List breakdown values
*MetricsApi* | [**listInsights**](docs/MetricsApi.md#listInsights) | **GET** /data/v1/metrics/{METRIC_ID}/insights | List Insights
*MonitoringApi* | [**getMonitoringBreakdown**](docs/MonitoringApi.md#getMonitoringBreakdown) | **GET** /data/v1/monitoring/metrics/{MONITORING_METRIC_ID}/breakdown | Get Monitoring Breakdown
*MonitoringApi* | [**getMonitoringBreakdownTimeseries**](docs/MonitoringApi.md#getMonitoringBreakdownTimeseries) | **GET** /data/v1/monitoring/metrics/{MONITORING_METRIC_ID}/breakdown-timeseries | Get Monitoring Breakdown Timeseries
*MonitoringApi* | [**getMonitoringHistogramTimeseries**](docs/MonitoringApi.md#getMonitoringHistogramTimeseries) | **GET** /data/v1/monitoring/metrics/{MONITORING_HISTOGRAM_METRIC_ID}/histogram-timeseries | Get Monitoring Histogram Timeseries
*MonitoringApi* | [**getMonitoringTimeseries**](docs/MonitoringApi.md#getMonitoringTimeseries) | **GET** /data/v1/monitoring/metrics/{MONITORING_METRIC_ID}/timeseries | Get Monitoring Timeseries
*MonitoringApi* | [**listMonitoringDimensions**](docs/MonitoringApi.md#listMonitoringDimensions) | **GET** /data/v1/monitoring/dimensions | List Monitoring Dimensions
Expand Down Expand Up @@ -219,6 +220,7 @@ Class | Method | HTTP request | Description
- [AbridgedVideoView](docs/AbridgedVideoView.md)
- [Asset](docs/Asset.md)
- [AssetErrors](docs/AssetErrors.md)
- [AssetGeneratedSubtitleSettings](docs/AssetGeneratedSubtitleSettings.md)
- [AssetMaster](docs/AssetMaster.md)
- [AssetNonStandardInputReasons](docs/AssetNonStandardInputReasons.md)
- [AssetRecordingTimes](docs/AssetRecordingTimes.md)
Expand Down Expand Up @@ -260,6 +262,7 @@ Class | Method | HTTP request | Description
- [GetLiveStreamPlaybackIDResponse](docs/GetLiveStreamPlaybackIDResponse.md)
- [GetMetricTimeseriesDataResponse](docs/GetMetricTimeseriesDataResponse.md)
- [GetMonitoringBreakdownResponse](docs/GetMonitoringBreakdownResponse.md)
- [GetMonitoringBreakdownTimeseriesResponse](docs/GetMonitoringBreakdownTimeseriesResponse.md)
- [GetMonitoringHistogramTimeseriesResponse](docs/GetMonitoringHistogramTimeseriesResponse.md)
- [GetMonitoringHistogramTimeseriesResponseMeta](docs/GetMonitoringHistogramTimeseriesResponseMeta.md)
- [GetMonitoringTimeseriesResponse](docs/GetMonitoringTimeseriesResponse.md)
Expand Down Expand Up @@ -312,6 +315,8 @@ Class | Method | HTTP request | Description
- [LiveStreamResponse](docs/LiveStreamResponse.md)
- [LiveStreamStatus](docs/LiveStreamStatus.md)
- [Metric](docs/Metric.md)
- [MonitoringBreakdownTimeseriesDatapoint](docs/MonitoringBreakdownTimeseriesDatapoint.md)
- [MonitoringBreakdownTimeseriesValues](docs/MonitoringBreakdownTimeseriesValues.md)
- [MonitoringBreakdownValue](docs/MonitoringBreakdownValue.md)
- [MonitoringHistogramTimeseriesBucket](docs/MonitoringHistogramTimeseriesBucket.md)
- [MonitoringHistogramTimeseriesBucketValues](docs/MonitoringHistogramTimeseriesBucketValues.md)
Expand Down
2 changes: 1 addition & 1 deletion build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ plugins {
}

group = 'com.mux'
version = '0.6.3'
version = '0.7.0'

repositories {
mavenCentral()
Expand Down
36 changes: 35 additions & 1 deletion docs/Asset.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,10 @@ Name | Type | Description | Notes
**createdAt** | **String** | Time the Asset was created, defined as a Unix timestamp (seconds since epoch). | [optional]
**status** | [**StatusEnum**](#StatusEnum) | The status of the asset. | [optional]
**duration** | **Double** | The duration of the asset in seconds (max duration for a single asset is 12 hours). | [optional]
**maxStoredResolution** | [**MaxStoredResolutionEnum**](#MaxStoredResolutionEnum) | The maximum resolution that has been stored for the asset. The asset may be delivered at lower resolutions depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. | [optional]
**maxStoredResolution** | [**MaxStoredResolutionEnum**](#MaxStoredResolutionEnum) | This field is deprecated. Please use &#x60;resolution_tier&#x60; instead. The maximum resolution that has been stored for the asset. The asset may be delivered at lower resolutions depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. | [optional]
**resolutionTier** | [**ResolutionTierEnum**](#ResolutionTierEnum) | The resolution tier that the asset was ingested at, affecting billing for ingest &amp; storage. This field also represents the highest resolution tier that the content can be delivered at, however the actual resolution may be lower depending on the device, bandwidth, and exact resolution of the uploaded asset. | [optional]
**maxResolutionTier** | [**MaxResolutionTierEnum**](#MaxResolutionTierEnum) | Max resolution tier can be used to control the maximum &#x60;resolution_tier&#x60; your asset is encoded, stored, and streamed at. If not set, this defaults to &#x60;1080p&#x60;. | [optional]
**encodingTier** | [**EncodingTierEnum**](#EncodingTierEnum) | The encoding tier informs the cost, quality, and available platform features for the asset. By default the &#x60;smart&#x60; encoding tier is used. | [optional]
**maxStoredFrameRate** | **Double** | The maximum frame rate that has been stored for the asset. The asset may be delivered at lower frame rates depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. This field may return -1 if the frame rate of the input cannot be reliably determined. | [optional]
**aspectRatio** | **String** | The aspect ratio of the asset in the form of &#x60;width:height&#x60;, for example &#x60;16:9&#x60;. | [optional]
**playbackIds** | [**java.util.List&lt;PlaybackID&gt;**](PlaybackID.md) | An array of Playback ID objects. Use these to create HLS playback URLs. See [Play your videos](https://docs.mux.com/guides/video/play-your-videos) for more details. | [optional]
Expand Down Expand Up @@ -55,6 +58,37 @@ UHD | &quot;UHD&quot;



## Enum: ResolutionTierEnum

Name | Value
---- | -----
AUDIO_ONLY | &quot;audio-only&quot;
_720P | &quot;720p&quot;
_1080P | &quot;1080p&quot;
_1440P | &quot;1440p&quot;
_2160P | &quot;2160p&quot;



## Enum: MaxResolutionTierEnum

Name | Value
---- | -----
_1080P | &quot;1080p&quot;
_1440P | &quot;1440p&quot;
_2160P | &quot;2160p&quot;



## Enum: EncodingTierEnum

Name | Value
---- | -----
SMART | &quot;smart&quot;
BASELINE | &quot;baseline&quot;



## Enum: MasterAccessEnum

Name | Value
Expand Down
23 changes: 23 additions & 0 deletions docs/AssetGeneratedSubtitleSettings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@


# AssetGeneratedSubtitleSettings

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | A name for this subtitle track. | [optional]
**passthrough** | **String** | Arbitrary metadata set for the subtitle track. Max 255 characters. | [optional]
**languageCode** | [**LanguageCodeEnum**](#LanguageCodeEnum) | The language to generate subtitles in. | [optional]



## Enum: LanguageCodeEnum

Name | Value
---- | -----
EN | &quot;en&quot;
EN_US | &quot;en-US&quot;



2 changes: 1 addition & 1 deletion docs/AssetsApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ Name | Type | Description | Notes

Create an asset track

Adds an asset track (for example, subtitles) to an asset.
Adds an asset track (for example, subtitles, or an alternate audio track) to an asset.

### Example
```java
Expand Down
21 changes: 21 additions & 0 deletions docs/CreateAssetRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Name | Type | Description | Notes
**normalizeAudio** | **Boolean** | Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets. | [optional]
**masterAccess** | [**MasterAccessEnum**](#MasterAccessEnum) | Specify what level (if any) of support for master access. Master access can be enabled temporarily for your asset to be downloaded. See the [Download your videos guide](/guides/video/download-your-videos) for more information. | [optional]
**test** | **Boolean** | Marks the asset as a test asset when the value is set to true. A Test asset can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test assets created. Test asset are watermarked with the Mux logo, limited to 10 seconds, deleted after 24 hrs. | [optional]
**maxResolutionTier** | [**MaxResolutionTierEnum**](#MaxResolutionTierEnum) | Max resolution tier can be used to control the maximum &#x60;resolution_tier&#x60; your asset is encoded, stored, and streamed at. If not set, this defaults to &#x60;1080p&#x60;. | [optional]
**encodingTier** | [**EncodingTierEnum**](#EncodingTierEnum) | The encoding tier informs the cost, quality, and available platform features for the asset. By default the &#x60;smart&#x60; encoding tier is used. | [optional]



Expand All @@ -35,3 +37,22 @@ TEMPORARY | &quot;temporary&quot;



## Enum: MaxResolutionTierEnum

Name | Value
---- | -----
_1080P | &quot;1080p&quot;
_1440P | &quot;1440p&quot;
_2160P | &quot;2160p&quot;



## Enum: EncodingTierEnum

Name | Value
---- | -----
SMART | &quot;smart&quot;
BASELINE | &quot;baseline&quot;



4 changes: 2 additions & 2 deletions docs/CreateLiveStreamRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ Name | Type | Description | Notes
**audioOnly** | **Boolean** | Force the live stream to only process the audio track when the value is set to true. Mux drops the video track if broadcasted. | [optional]
**embeddedSubtitles** | [**java.util.List&lt;LiveStreamEmbeddedSubtitleSettings&gt;**](LiveStreamEmbeddedSubtitleSettings.md) | Describe the embedded closed caption contents of the incoming live stream. | [optional]
**generatedSubtitles** | [**java.util.List&lt;LiveStreamGeneratedSubtitleSettings&gt;**](LiveStreamGeneratedSubtitleSettings.md) | Configure the incoming live stream to include subtitles created with automatic speech recognition. Each Asset created from a live stream with &#x60;generated_subtitles&#x60; configured will automatically receive two text tracks. The first of these will have a &#x60;text_source&#x60; value of &#x60;generated_live&#x60;, and will be available with &#x60;ready&#x60; status as soon as the stream is live. The second text track will have a &#x60;text_source&#x60; value of &#x60;generated_live_final&#x60; and will contain subtitles with improved accuracy, timing, and formatting. However, &#x60;generated_live_final&#x60; tracks will not be available in &#x60;ready&#x60; status until the live stream ends. If an Asset has both &#x60;generated_live&#x60; and &#x60;generated_live_final&#x60; tracks that are &#x60;ready&#x60;, then only the &#x60;generated_live_final&#x60; track will be included during playback. | [optional]
**reducedLatency** | **Boolean** | This field is deprecated. Please use latency_mode instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this if you want lower latency for your live stream. Read more here: https://mux.com/blog/reduced-latency-for-mux-live-streaming-now-available/ | [optional]
**lowLatency** | **Boolean** | This field is deprecated. Please use latency_mode instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Setting this option will enable compatibility with the LL-HLS specification for low-latency streaming. This typically has lower latency than Reduced Latency streams, and cannot be combined with Reduced Latency. | [optional]
**reducedLatency** | **Boolean** | This field is deprecated. Please use &#x60;latency_mode&#x60; instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this if you want lower latency for your live stream. Read more here: https://mux.com/blog/reduced-latency-for-mux-live-streaming-now-available/ | [optional]
**lowLatency** | **Boolean** | This field is deprecated. Please use &#x60;latency_mode&#x60; instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Setting this option will enable compatibility with the LL-HLS specification for low-latency streaming. This typically has lower latency than Reduced Latency streams, and cannot be combined with Reduced Latency. | [optional]
**latencyMode** | [**LatencyModeEnum**](#LatencyModeEnum) | Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags. The Low Latency value is a beta feature. Read more here: https://mux.com/blog/introducing-low-latency-live-streaming/ | [optional]
**test** | **Boolean** | Marks the live stream as a test live stream when the value is set to true. A test live stream can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test live streams created. Test live streams are watermarked with the Mux logo and limited to 5 minutes. The test live stream is disabled after the stream is active for 5 mins and the recorded asset also deleted after 24 hours. | [optional]
**simulcastTargets** | [**java.util.List&lt;CreateSimulcastTargetRequest&gt;**](CreateSimulcastTargetRequest.md) | | [optional]
Expand Down
5 changes: 3 additions & 2 deletions docs/CreateTrackRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**url** | **String** | |
**url** | **String** | The URL of the file that Mux should download and use. * For &#x60;audio&#x60; 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 &#x60;text&#x60; 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. |
**type** | [**TypeEnum**](#TypeEnum) | |
**textType** | [**TextTypeEnum**](#TextTypeEnum) | |
**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. |
**name** | **String** | The name of the track containing a human-readable description. This value must be unique across all the text type and subtitles text type tracks. HLS manifest will associate subtitle text track with this value. For example, set the value to \&quot;English\&quot; for subtitles text track with language_code as en-US. If this parameter is not included, Mux will auto-populate based on the language_code value. | [optional]
**name** | **String** | The name of the track containing a human-readable description. This value must be unique within each group of &#x60;text&#x60; or &#x60;audio&#x60; track types. The HLS manifest will associate the &#x60;text&#x60; or &#x60;audio&#x60; track with this value. For example, set the value to \&quot;English\&quot; for subtitles text track with &#x60;language_code&#x60; as en-US. If this parameter is not included, Mux will auto-populate a value based on the &#x60;language_code&#x60; value. | [optional]
**closedCaptions** | **Boolean** | Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). | [optional]
**passthrough** | **String** | Arbitrary user-supplied metadata set for the track either when creating the asset or track. | [optional]

Expand All @@ -21,6 +21,7 @@ Name | Type | Description | Notes
Name | Value
---- | -----
TEXT | &quot;text&quot;
AUDIO | &quot;audio&quot;



Expand Down
13 changes: 13 additions & 0 deletions docs/DeliveryReport.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Name | Type | Description | Notes
**deletedAt** | **String** | If exists, time at which the asset was deleted. Measured in seconds since the Unix epoch. | [optional]
**assetState** | [**AssetStateEnum**](#AssetStateEnum) | The state of the asset. | [optional]
**assetDuration** | **Double** | The duration of the asset in seconds. | [optional]
**assetResolutionTier** | [**AssetResolutionTierEnum**](#AssetResolutionTierEnum) | The resolution tier that the asset was ingested at, affecting billing for ingest &amp; storage | [optional]
**deliveredSeconds** | **Double** | Total number of delivered seconds during this time window. | [optional]
**deliveredSecondsByResolution** | [**DeliveryReportDeliveredSecondsByResolution**](DeliveryReportDeliveredSecondsByResolution.md) | | [optional]

Expand All @@ -28,3 +29,15 @@ DELETED | &quot;deleted&quot;



## Enum: AssetResolutionTierEnum

Name | Value
---- | -----
AUDIO_ONLY | &quot;audio-only&quot;
_720P | &quot;720p&quot;
_1080P | &quot;1080p&quot;
_1440P | &quot;1440p&quot;
_2160P | &quot;2160p&quot;



14 changes: 14 additions & 0 deletions docs/GetMonitoringBreakdownTimeseriesResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@


# GetMonitoringBreakdownTimeseriesResponse

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**java.util.List&lt;MonitoringBreakdownTimeseriesValues&gt;**](MonitoringBreakdownTimeseriesValues.md) | | [optional]
**totalRowCount** | **Long** | | [optional]
**timeframe** | **java.util.List&lt;Long&gt;** | | [optional]



Loading
Loading