MarkdownMediaLinkOptions Class

How MarkdownExtensions.MediaLinks renders the images of audio, video, and of the sites that host them.

public sealed class MarkdownMediaLinkOptions : IEquatable<MarkdownMediaLinkOptions>
Implements

Constructors

NameDescription
MarkdownMediaLinkOptions()

MarkdownMediaLinkOptions()

MarkdownMediaLinkOptions.cs
public MarkdownMediaLinkOptions()

No documentation is available.

Properties

NameDescription
AddControlsGets a value indicating whether audio and video have the controls attribute.
ClassGets the class of the element, or an empty string for none.
DefaultGets the options of Markdig: a width of 500, a height of 281, controls, and the hosts of IMarkdownMediaHost.KnownHosts.
ExtensionToMimeTypeGets the MIME types of the extensions of the audio and the video files, such as .mp4. By default, the formats that browsers play: .mp4, .m4v, .webm, .ogv, .mov, .mkv, .3gp, .3g2, .mpeg and .mpg for video, and .mp3, .m4a, .aac, .ogg, .oga, .opus, .wav, .weba, .flac, .mka, .aif and .aiff for audio. The keys start with a dot, and a dictionary whose comparer ignores the case matches .MP4 too.
HeightGets the height of the element, or an empty string for none. Audio has no height.
HostsGets the sites whose links are rendered as an <iframe>, tried in order.
WidthGets the width of the element, or an empty string for none.

Gets a value indicating whether audio and video have the controls attribute.

public bool AddControls { get; init; }

Property value

bool

Gets the class of the element, or an empty string for none.

public string Class { get; init; }

Property value

string

Gets the options of Markdig: a width of 500, a height of 281, controls, and the hosts of IMarkdownMediaHost.KnownHosts.

public static MarkdownMediaLinkOptions Default { get; }

ExtensionToMimeType

MarkdownMediaLinkOptions.cs

Gets the MIME types of the extensions of the audio and the video files, such as .mp4. By default, the formats that browsers play: .mp4, .m4v, .webm, .ogv, .mov, .mkv, .3gp, .3g2, .mpeg and .mpg for video, and .mp3, .m4a, .aac, .ogg, .oga, .opus, .wav, .weba, .flac, .mka, .aif and .aiff for audio. The keys start with a dot, and a dictionary whose comparer ignores the case matches .MP4 too.

public IReadOnlyDictionary<string, string> ExtensionToMimeType { get; init; }

Gets the height of the element, or an empty string for none. Audio has no height.

public string Height { get; init; }

Property value

string

Gets the sites whose links are rendered as an <iframe>, tried in order.

public ImmutableArray<IMarkdownMediaHost> Hosts { get; init; }

Gets the width of the element, or an empty string for none.

public string Width { get; init; }

Property value

string

Methods

NameDescription
Equals(MarkdownMediaLinkOptions?)
Equals(object?)
GetHashCode()
ToString()

Equals overloads

Equals(MarkdownMediaLinkOptions?)

public bool Equals(MarkdownMediaLinkOptions? other)
Parameters
other MarkdownMediaLinkOptions?
Returns

bool

No documentation is available.

Equals(object?)

public override bool Equals(object? obj)
Parameters
obj object?
Returns

bool

No documentation is available.

GetHashCode()

public override int GetHashCode()

Returns

int

No documentation is available.

ToString()

public override string ToString()

Returns

string

No documentation is available.

Operators

NameDescription
operator ==(MarkdownMediaLinkOptions?, MarkdownMediaLinkOptions?)
operator !=(MarkdownMediaLinkOptions?, MarkdownMediaLinkOptions?)

operator ==(MarkdownMediaLinkOptions?, MarkdownMediaLinkOptions?)

public static bool operator ==(MarkdownMediaLinkOptions? left, MarkdownMediaLinkOptions? right)

No documentation is available.

operator !=(MarkdownMediaLinkOptions?, MarkdownMediaLinkOptions?)

public static bool operator !=(MarkdownMediaLinkOptions? left, MarkdownMediaLinkOptions? right)

No documentation is available.