Skip to content

Commit 50acdd6

Browse files
Update README.md
1 parent 7fc2749 commit 50acdd6

1 file changed

Lines changed: 8 additions & 6 deletions

File tree

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# H264Sharp
2-
Cisco's OpenH264 C++/CLI wrapper in C# with optimised image format conversions. It is very suitable for realtime streaming.
2+
Cisco's OpenH264 C++/CLI wrapper in C# with optimised image format conversions. It is very suitable for realtime streaming over network.
33
- Offers managed and unmanaged intuitive API.
44
- Tested on .NetFramework and NetCore(upto 7).
55
- Compatible with OpenCV.(i.e. OpenCVsharp)
@@ -8,9 +8,8 @@ Cisco's OpenH264 C++/CLI wrapper in C# with optimised image format conversions.
88
- Simple console application example is provided on repo as an example.
99

1010
### Setup
11-
- Empty Constructor will look for 32 or 64 bit openh264 dll with its default name automatically on executable directory(i.e. Debug/Release folder of your project).
11+
- Default Constructor will look for `openh264-2.3.1-win32.dll` or `openh264-2.3.1-win64.dll` automatically on executable directory depending on process type.
1212
- You can setup with a different dll name, constructor is overloaded.
13-
1413
``` c#
1514
decoder = new H264Sharp.Decoder();
1615

@@ -27,6 +26,7 @@ Cisco's OpenH264 C++/CLI wrapper in C# with optimised image format conversions.
2726
{
2827
foreach (var frame in frames)
2928
{
29+
//hints..
3030
//byte[] b = frame.ToByteArray();
3131
//frame.CopyTo(buffer, 0);
3232
Decode(frame.Data, frame.Length, frame.Type);
@@ -60,9 +60,11 @@ A separate dll is provided for RGB <-> YUV conversions. Its compiled with clang
6060

6161
# TLDR how to install
6262
- Go to my releases find lates version.
63-
- Reference/Include H264Sharp dll on your project.
64-
- Add `openh264-2.3.1-win32.dll` or `openh264-2.3.1-win64.dll` or both to your executable directory. (keep the original names if you want to use default constructor)
65-
- Optionally Add Converter64/32 dlls to your executable directory.
63+
- Reference H264Sharp dll on your project.
64+
- Add `openh264-2.3.1-win32.dll` or `openh264-2.3.1-win64.dll` or both to your executable directory(Or include on your project and ckeck copy to output-> copy if newer).
65+
- Keep the original names if you want to use default constructors.
66+
- Optionally Add Converter64/32 dlls to your executable directory same way as openh264 dll.
67+
-
6668
# Remarks
6769
- Decode callbacks with raw image formats use cached backed buffer, if you wont consume them immediately, make a copy or sync your system.
6870
- Encoder output "EncodedFrame" uses cached back buffer if you wont consume them immediately, make a copy or sync your system.

0 commit comments

Comments
 (0)