Class MetaData

Namespace

RadioExt_Helper.models

Assembly

RadioExt-Helper.dll

Represents the metadata that describes a radio stations properties.

public sealed class MetaData : INotifyPropertyChanged, ICloneable, IEquatable<MetaData>

Inheritance

object

MetaData

Implements

INotifyPropertyChanged

ICloneable

IEquatable<MetaData>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

CustomData

A dictionary of custom data that can be used to store additional information about the station.

[JsonProperty("custom_data")]
public SerializableDictionary<string, object> CustomData { get; set; }

Property Value

SerializableDictionary<string, object>

CustomIcon

Defines the custom icon to use for the station, if applicable. If not using a custom icon, this property is not used.

[JsonProperty("customIcon")]
public CustomIcon CustomIcon { get; set; }

Property Value

CustomIcon

DisplayName

The name of the station that will be displayed in game. Also used for the station folder.

[JsonProperty("displayName")]
public string DisplayName { get; set; }

Property Value

string

Fm

Used to place the station at the right place in the stations list. If DisplayName has a number, it should be the same here.

[JsonProperty("fm")]
public float Fm { get; set; }

Property Value

float

Icon

The icon for the station, if not using a custom one defined in CustomIcon.

[JsonProperty("icon")]
public string Icon { get; set; }

Property Value

string

IsActive

Indicates whether this station is enabled in game or not.

[JsonProperty("enabled")]
public bool IsActive { get; set; }

Property Value

bool

SongOrder

Specifies the order in which songs should be played. The order does not have to contain all the songs in the station. Any songs not specified in the order will be played randomly before/after the ordered section.

[JsonProperty("order")]
public List<string> SongOrder { get; set; }

Property Value

List<string>

StreamInfo

Defines the streaming properties for the station, if applicable. If using audio files instead of a web stream, this property is not used.

[JsonProperty("streamInfo")]
public StreamInfo StreamInfo { get; set; }

Property Value

StreamInfo

Volume

The overall volume multiplier for the station.

[JsonProperty("volume")]
public float Volume { get; set; }

Property Value

float

Methods

Clone()

Creates a new object that is a copy of the current instance.

public object Clone()

Returns

object

A new object that is a copy of this instance.

Equals(MetaData?)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(MetaData? other)

Parameters

other MetaData

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object?)

Determines whether the specified object is equal to the current object.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

ToString()

Get a display friendly value representing this metadata.

public override string ToString()

Returns

string

The DisplayName of the station.

Events

PropertyChanged

Occurs when a property value changes.

public event PropertyChangedEventHandler? PropertyChanged

Event Type

PropertyChangedEventHandler