Class VidFile

Opens and reads a Daggerfall VID file. Unlike most API classes, this one uses the UnityEngine namespace to directly decode image data to a Color32[] frame buffer for efficiency.

Inheritance

Object

VidFile

Namespace: DaggerfallConnect.Arena2

Assembly: Assembly-CSharp.dll

Syntax

public class VidFile

Constructors

| Improve this Doc View Source

VidFile()

Default constructor.

Declaration

public VidFile()

| Improve this Doc View Source

VidFile(String)

Open constructor.

Declaration

public VidFile(string filename)

Parameters

Type	Name	Description
String	filename	Filname of VID to open.

Properties

| Improve this Doc View Source

AudioBuffer

Declaration

public byte[] AudioBuffer { get; }

Property Value

Type	Description
Byte[]

| Improve this Doc View Source

CurrentBlock

Declaration

public int CurrentBlock { get; }

Property Value

Type	Description
Int32

| Improve this Doc View Source

EndOfFile

Declaration

public bool EndOfFile { get; }

Property Value

Type	Description
Boolean

| Improve this Doc View Source

FrameBuffer

Declaration

public Color32[] FrameBuffer { get; }

Property Value

Type	Description
Color32[]

| Improve this Doc View Source

FrameCount

Declaration

public int FrameCount { get; }

Property Value

Type	Description
Int32

| Improve this Doc View Source

FrameDelay

Declaration

public double FrameDelay { get; }

Property Value

Type	Description
Double

| Improve this Doc View Source

FrameHeight

Declaration

public int FrameHeight { get; }

Property Value

Type	Description
Int32

| Improve this Doc View Source

FrameWidth

Declaration

public int FrameWidth { get; }

Property Value

Type	Description
Int32

| Improve this Doc View Source

LastBlockType

Declaration

public VidBlockTypes LastBlockType { get; }

Property Value

Type	Description
VidBlockTypes

| Improve this Doc View Source

LastDelay

Declaration

public int LastDelay { get; }

Property Value

Type	Description
Int32

| Improve this Doc View Source

SampleRate

Declaration

public int SampleRate { get; }

Property Value

Type	Description
Int32

Methods

| Improve this Doc View Source

Open(String)

Open a VID file. Always uses a memory stream for performance.

Declaration

public bool Open(string filename)

Parameters

Type	Name	Description
String	filename	Filename of VID to open.

Returns

Type	Description
Boolean

| Improve this Doc View Source

ReadNextBlock()

Read next block from VID stream. Daggerfall's VID files are mostly interleaved audio and video streams. Occasionally there is a null block which must be rejected.

Declaration

public void ReadNextBlock()