/
BlockHeader.xml
107 lines (107 loc) · 4.58 KB
/
BlockHeader.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
<Type Name="BlockHeader" FullName="TagLib.Flac.BlockHeader">
<TypeSignature Language="C#" Value="public struct BlockHeader" />
<AssemblyInfo>
<AssemblyName>taglib-sharp</AssemblyName>
<AssemblyVersion>1.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces />
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public BlockHeader (TagLib.ByteVector data);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="data" Type="TagLib.ByteVector" />
</Parameters>
<Docs>
<param name="data">A <see cref="T:TagLib.ByteVector" /> containing a FLAC block header.</param>
<summary>Constructs and initializes a new instance of <see cref="T:TagLib.Flac.BlockHeader" /> by reading the contents of a FLACK block header.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public BlockHeader (TagLib.Flac.BlockType type, uint length);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="type" Type="TagLib.Flac.BlockType" />
<Parameter Name="length" Type="System.UInt32" />
</Parameters>
<Docs>
<param name="type">A <see cref="T:TagLib.Flac.BlockType" /> specifying the block type of the new instance.</param>
<param name="length">A <see cref="T:System.UInt32" /> specifying the block length of the new instance.</param>
<summary>Constructs and initializes a new instance of <see cref="T:TagLib.Flac.BlockHeader" /> with a specific type and length.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Render">
<MemberSignature Language="C#" Value="public TagLib.ByteVector Render (bool is_last_block);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>TagLib.ByteVector</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="is_last_block" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="is_last_block">A <see cref="T:System.Boolean" /> specifying whether or not the block represented by the current instance is the last in the set.</param>
<summary>Renders the current instance as a FLAC block header.</summary>
<returns>A new <see cref="T:TagLib.ByteVector" /> containing the rendered version of the current instance.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Length">
<MemberSignature Language="C#" Value="public static uint Length { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the length of a block header.</summary>
<value>Always 4.</value>
<remarks />
</Docs>
</Member>
<Member MemberName="BlockType">
<MemberSignature Language="C#" Value="public TagLib.Flac.BlockType BlockType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>TagLib.Flac.BlockType</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the block type of the current instance.</summary>
<value>A <see cref="T:TagLib.Flac.BlockType" /> describing contents of the block represented by the current instance.</value>
<remarks />
</Docs>
</Member>
<Member MemberName="IsLastBlock">
<MemberSignature Language="C#" Value="public bool IsLastBlock { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets whether or not the block represented by the current instance.</summary>
<value>A <see cref="T:System.Boolean" /> containing whether or not the block represented by the current instance.</value>
<remarks />
</Docs>
</Member>
<Member MemberName="BlockLength">
<MemberSignature Language="C#" Value="public uint BlockLength { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the length of the block represented by the current instance.</summary>
<value>A <see cref="T:TagLib.Flac.BlockType" /> containing the length of the block represented by the current instance.</value>
<remarks />
</Docs>
</Member>
</Members>
<Docs>
<summary>This struct is used to access FLAC block headers.</summary>
<remarks />
</Docs>
</Type>