Client
Server
Reference / @open-music-sdk/types / tStationAttributes
Interface: tStationAttributes
Defined in: station.ts:21
The attributes for a station resource.
Properties
artwork
ts
artwork: tArtwork;Defined in: station.ts:23
The radio station artwork.
contentRating?
ts
optional contentRating?: "clean" | "explicit";Defined in: station.ts:31
The rating of the content possibly heard while playing the station. The possible values for this rating are clean and explicit. No value means no rating.
durationInMillis?
ts
optional durationInMillis?: number;Defined in: station.ts:25
The duration of the stream. This value isn’t emitted for ‘live’ or programmed stations.
editorialNotes?
ts
optional editorialNotes?: tEditorialNotes;Defined in: station.ts:27
The notes about the station that appear in Apple Music.
episodeNumber?
ts
optional episodeNumber?: string;Defined in: station.ts:29
The episode number of the station. This value appears when the station represents an episode of a show or other content.
isLive
ts
isLive: boolean;Defined in: station.ts:33
Indicates whether the station is a livestream.
mediaKind
ts
mediaKind: "audio" | "video";Defined in: station.ts:35
The media kind for the station. It can have value audio or video depending on whether it has video stream or audio stream.
name
ts
name: string;Defined in: station.ts:37
The localized name of the station.
playParams?
ts
optional playParams?: tPlayParameters;Defined in: station.ts:39
When present, this attribute indicates that the radio station or episode is available to play with an Apple Music subscription. The value map may be used to initiate playback of the station. Live radio stations and episodes initiate streaming playback. Track-based stations initiate playback of individual tracks.
stationProviderName?
ts
optional stationProviderName?: string;Defined in: station.ts:41
The name of the entity that provided the station, when specified.
url
ts
url: string;Defined in: station.ts:43
The URL for sharing the station in Apple Music.