Class MediaContentRequestParameters
Defines how the media content should be returned
Inheritance
System.Object
MediaContentRequestParameters
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: ImageVault.Core.Common.Data
Assembly: ImageVault.Core.dll
Syntax
public class MediaContentRequestParametersConstructors
MediaContentRequestParameters(MediaContentRequestFormat, Int64, Int64, Boolean, Int32, String, Uri)
Declaration
public MediaContentRequestParameters(MediaContentRequestFormat requestFormat, long offset = 0L, long length = 0L, bool download = false, int sasTokenDuration = 0, string name = null, Uri uri = null)Parameters
| Type | Name | Description |
|---|---|---|
| ImageVault.Abstractions.MediaContentRequestFormat | requestFormat | |
| System.Int64 | offset | |
| System.Int64 | length | |
| System.Boolean | download | |
| System.Int32 | sasTokenDuration | |
| System.String | name | |
| System.Uri | uri |
Fields
LocalStream
Requests the whole media as a local stream
Declaration
public static readonly MediaContentRequestParameters LocalStreamField Value
| Type | Description |
|---|---|
| MediaContentRequestParameters |
Stream
Requests the whole media as a stream
Declaration
public static readonly MediaContentRequestParameters StreamField Value
| Type | Description |
|---|---|
| MediaContentRequestParameters |
UriOrStream
Requests the whole media as an uri or as a stream
Declaration
public static readonly MediaContentRequestParameters UriOrStreamField Value
| Type | Description |
|---|---|
| MediaContentRequestParameters |
UriWithSasToken
Requests the media as an uri with a valid Sas token
Declaration
public static readonly MediaContentRequestParameters UriWithSasTokenField Value
| Type | Description |
|---|---|
| MediaContentRequestParameters |
Properties
Download
Requests to download the media
Declaration
public bool Download { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Extension
Gets the extension of the requested item
Declaration
public string Extension { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Length
For partial requests, the length of the content that should be returned
Declaration
public long Length { get; }Property Value
| Type | Description |
|---|---|
| System.Int64 |
Remarks
0 indicates that the whole content should be returned (from the offset)
Name
Name of the requested content
Declaration
public string Name { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Offset
For partial requests, the offset of the content where the response should start
Declaration
public long Offset { get; }Property Value
| Type | Description |
|---|---|
| System.Int64 |
RequestFormat
The requested format of the content
Declaration
public MediaContentRequestFormat RequestFormat { get; }Property Value
| Type | Description |
|---|---|
| ImageVault.Abstractions.MediaContentRequestFormat |
SasTokenDuration
The duration of the requested Sas token in seconds
Declaration
public int SasTokenDuration { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
Uri
Url that the request originated from
Declaration
public Uri Uri { get; }Property Value
| Type | Description |
|---|---|
| System.Uri |
Methods
Equals(MediaContentRequestParameters)
Declaration
protected bool Equals(MediaContentRequestParameters other)Parameters
| Type | Name | Description |
|---|---|---|
| MediaContentRequestParameters | other |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Equals(Object)
Declaration
public override bool Equals(object obj)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | obj |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Overrides
System.Object.Equals(System.Object)
GetHashCode()
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| System.Int32 |
Overrides
System.Object.GetHashCode()
ToString()
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| System.String |
Overrides
System.Object.ToString()