Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings
This repository was archived by the owner on Mar 30, 2019. It is now read-only.
/SharpDXPublic archive

Commitd645e32

Browse files
committed
Added documentation for wrappers.
1 parentea30cbf commitd645e32

File tree

5 files changed

+78
-1
lines changed

5 files changed

+78
-1
lines changed

‎Source/SharpDX.MediaFoundation/CaptureEngine.cs‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
usingSystem;
1+
#ifDESKTOP_APP
2+
usingSystem;
23
usingSystem.Collections.Generic;
34
usingSystem.Linq;
45
usingSystem.Text;
@@ -78,3 +79,5 @@ public void OnEvent(MediaEvent mediaEvent)
7879
}
7980
}
8081
}
82+
83+
#endif

‎Source/SharpDX.MediaFoundation/CapturePhotoSink.cs‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,18 @@ namespace SharpDX.MediaFoundation
99
{
1010
publicpartialclassCapturePhotoSink
1111
{
12+
/// <summary>
13+
/// <p>Specifies a byte stream that will receive the still image data.</p>
14+
/// </summary>
15+
/// <param name="byteStreamRef"><dd> <p>A reference to the <strong><see cref="SharpDX.MediaFoundation.IByteStream"/></strong> interface of a byte stream. The byte stream must be writable.</p> </dd></param>
16+
/// <returns><p>If this method succeeds, it returns <strong><see cref="SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="SharpDX.Result"/></strong> error code.</p></returns>
17+
/// <remarks>
18+
/// <p>Calling this method overrides any previous call to <strong><see cref="SharpDX.MediaFoundation.CapturePhotoSink.SetOutputFileName"/></strong> or <strong><see cref="SharpDX.MediaFoundation.CapturePhotoSink.SetSampleCallback_"/></strong>.</p>
19+
/// </remarks>
20+
/// <include file='.\..\Documentation\CodeComments.xml' path="/comments/comment[@id='IMFCapturePhotoSink::SetOutputByteStream']/*"/>
21+
/// <msdn-id>hh447862</msdn-id>
22+
/// <unmanaged>HRESULT IMFCapturePhotoSink::SetOutputByteStream([In] IMFByteStream* pByteStream)</unmanaged>
23+
/// <unmanaged-short>IMFCapturePhotoSink::SetOutputByteStream</unmanaged-short>
1224
publicByteStreamOutputByteStream
1325
{
1426
set
@@ -17,6 +29,18 @@ public ByteStream OutputByteStream
1729
}
1830
}
1931

32+
/// <summary>
33+
/// <p>Sets a callback to receive the still-image data.</p>
34+
/// </summary>
35+
/// <param name="callbackRef"><dd> <p>A reference to the <strong><see cref="SharpDX.MediaFoundation.CaptureEngineOnSampleCallback"/></strong> interface. The caller must implement this interface.</p> </dd></param>
36+
/// <returns><p>If this method succeeds, it returns <strong><see cref="SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="SharpDX.Result"/></strong> error code.</p></returns>
37+
/// <remarks>
38+
/// <p>Calling this method overrides any previous call to <strong><see cref="SharpDX.MediaFoundation.CapturePhotoSink.SetOutputByteStream_"/></strong> or <strong><see cref="SharpDX.MediaFoundation.CapturePhotoSink.SetOutputFileName"/></strong>.</p>
39+
/// </remarks>
40+
/// <include file='.\..\Documentation\CodeComments.xml' path="/comments/comment[@id='IMFCapturePhotoSink::SetSampleCallback']/*"/>
41+
/// <msdn-id>hh447864</msdn-id>
42+
/// <unmanaged>HRESULT IMFCapturePhotoSink::SetSampleCallback([In] IMFCaptureEngineOnSampleCallback* pCallback)</unmanaged>
43+
/// <unmanaged-short>IMFCapturePhotoSink::SetSampleCallback</unmanaged-short>
2044
publicCaptureEngineOnSampleCallbackSampleCallback
2145
{
2246
set

‎Source/SharpDX.MediaFoundation/CapturePreviewSink.cs‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,19 @@ namespace SharpDX.MediaFoundation
99
{
1010
publicpartialclassCapturePreviewSink
1111
{
12+
/// <summary>
13+
/// <p>Sets a callback to receive the preview data for one stream.</p>
14+
/// </summary>
15+
/// <param name="dwStreamSinkIndex"><dd> <p>The zero-based index of the stream. The index is returned in the <em>pdwSinkStreamIndex</em> parameter of the <strong><see cref="SharpDX.MediaFoundation.CaptureSink.AddStream"/></strong> method.</p> </dd></param>
16+
/// <param name="callbackRef"><dd> <p>A reference to the <strong><see cref="SharpDX.MediaFoundation.CaptureEngineOnSampleCallback"/></strong> interface. The caller must implement this interface.</p> </dd></param>
17+
/// <returns><p>If this method succeeds, it returns <strong><see cref="SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="SharpDX.Result"/></strong> error code.</p></returns>
18+
/// <remarks>
19+
/// <p>Calling this method overrides any previous call to <strong><see cref="SharpDX.MediaFoundation.CapturePreviewSink.SetRenderHandle"/></strong>.</p>
20+
/// </remarks>
21+
/// <include file='.\..\Documentation\CodeComments.xml' path="/comments/comment[@id='IMFCapturePreviewSink::SetSampleCallback']/*"/>
22+
/// <msdn-id>hh447873</msdn-id>
23+
/// <unmanaged>HRESULT IMFCapturePreviewSink::SetSampleCallback([In] unsigned int dwStreamSinkIndex,[In] IMFCaptureEngineOnSampleCallback* pCallback)</unmanaged>
24+
/// <unmanaged-short>IMFCapturePreviewSink::SetSampleCallback</unmanaged-short>
1225
publicvoidSetSampleCallback(intstreamSinkIndex,CaptureEngineOnSampleCallbackcallback)
1326
{
1427
SetSampleCallback_(streamSinkIndex,CaptureEngineOnSampleCallbackShadow.ToIntPtr(callback));

‎Source/SharpDX.MediaFoundation/CaptureRecordSink.cs‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,37 @@ namespace SharpDX.MediaFoundation
99
{
1010
publicpartialclassCaptureRecordSink
1111
{
12+
/// <summary>
13+
/// <p>Specifies a byte stream that will receive the data for the recording.</p>
14+
/// </summary>
15+
/// <param name="byteStreamRef"><dd> <p>A reference to the <strong><see cref="SharpDX.MediaFoundation.IByteStream"/></strong> interface of a byte stream. The byte stream must be writable.</p> </dd></param>
16+
/// <param name="guidContainerType"><dd> <p>A <see cref="System.Guid"/> that specifies the file container type. Possible values are documented in the <see cref="SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeContainertype"/> attribute.</p> </dd></param>
17+
/// <returns><p>If this method succeeds, it returns <strong><see cref="SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="SharpDX.Result"/></strong> error code.</p></returns>
18+
/// <remarks>
19+
/// <p>Calling this method overrides any previous call to <strong><see cref="SharpDX.MediaFoundation.CaptureRecordSink.SetOutputFileName"/></strong> or <strong><see cref="SharpDX.MediaFoundation.CaptureRecordSink.SetSampleCallback_"/></strong>.</p>
20+
/// </remarks>
21+
/// <include file='.\..\Documentation\CodeComments.xml' path="/comments/comment[@id='IMFCaptureRecordSink::SetOutputByteStream']/*"/>
22+
/// <msdn-id>hh447878</msdn-id>
23+
/// <unmanaged>HRESULT IMFCaptureRecordSink::SetOutputByteStream([In] IMFByteStream* pByteStream,[In] const GUID&amp; guidContainerType)</unmanaged>
24+
/// <unmanaged-short>IMFCaptureRecordSink::SetOutputByteStream</unmanaged-short>
1225
publicvoidSetOutputByteStream(ByteStreamstream,GuidcontainerType)
1326
{
1427
SetOutputByteStream_(stream.NativePointer,containerType);
1528
}
1629

30+
/// <summary>
31+
/// <p>Sets a callback to receive the recording data for one stream.</p>
32+
/// </summary>
33+
/// <param name="dwStreamSinkIndex"><dd> <p>The zero-based index of the stream. The index is returned in the <em>pdwSinkStreamIndex</em> parameter of the <strong><see cref="SharpDX.MediaFoundation.CaptureSink.AddStream"/></strong> method.</p> </dd></param>
34+
/// <param name="callbackRef"><dd> <p>A reference to the <strong><see cref="SharpDX.MediaFoundation.CaptureEngineOnSampleCallback"/></strong> interface. The caller must implement this interface.</p> </dd></param>
35+
/// <returns><p>If this method succeeds, it returns <strong><see cref="SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="SharpDX.Result"/></strong> error code.</p></returns>
36+
/// <remarks>
37+
/// <p>Calling this method overrides any previous call to <strong><see cref="SharpDX.MediaFoundation.CaptureRecordSink.SetOutputByteStream_"/></strong> or <strong><see cref="SharpDX.MediaFoundation.CaptureRecordSink.SetOutputFileName"/></strong>.</p>
38+
/// </remarks>
39+
/// <include file='.\..\Documentation\CodeComments.xml' path="/comments/comment[@id='IMFCaptureRecordSink::SetSampleCallback']/*"/>
40+
/// <msdn-id>hh447881</msdn-id>
41+
/// <unmanaged>HRESULT IMFCaptureRecordSink::SetSampleCallback([In] unsigned int dwStreamSinkIndex,[In] IMFCaptureEngineOnSampleCallback* pCallback)</unmanaged>
42+
/// <unmanaged-short>IMFCaptureRecordSink::SetSampleCallback</unmanaged-short>
1743
publicvoidSetSampleCallback(intstreamSinkIndex,CaptureEngineOnSampleCallbackcallback)
1844
{
1945
SetSampleCallback_(streamSinkIndex,CaptureEngineOnSampleCallbackShadow.ToIntPtr(callback));

‎Source/SharpDX.MediaFoundation/CaptureSink.cs‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,17 @@ namespace SharpDX.MediaFoundation
99
{
1010
publicpartialclassCaptureSink
1111
{
12+
/// <summary>
13+
/// <p>Queries the underlying Sink Writer object for an interface.</p>
14+
/// </summary>
15+
/// <param name="dwSinkStreamIndex">No documentation.</param>
16+
/// <param name="rguidService">No documentation.</param>
17+
/// <param name="riid">No documentation.</param>
18+
/// <returns>No documentation.</returns>
19+
/// <include file='.\..\Documentation\CodeComments.xml' path="/comments/comment[@id='IMFCaptureSink::GetService']/*"/>
20+
/// <msdn-id>hh447885</msdn-id>
21+
/// <unmanaged>HRESULT IMFCaptureSink::GetService([In] unsigned int dwSinkStreamIndex,[In] const GUID&amp; rguidService,[In] const GUID&amp; riid,[Out, Optional] IUnknown** ppUnknown)</unmanaged>
22+
/// <unmanaged-short>IMFCaptureSink::GetService</unmanaged-short>
1223
TGetService<T>(intsinkStreamIndex,GuidserviceGuid)
1324
whereT:ComObject
1425
{

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp