| Function Name | Section |
| Mpg24Net_ServerOpen | 4.3.1 |
| Mpg24Net_ServerClose | 4.3.2 |
| Mpg24Net_ServerStart | 4.3.3 |
| Mpg24Net_ServerStop | 4.3.4 |
| Mpg24Net_ServerSend | 4.3.5 |
| Mpg24Net_ClientOpen | 4.4.1 |
| Mpg24Net_ClientClose | 4.4.2 |
| Mpg24Net_ClientSetSubType | 4.4.3 |
| Mpg24Net_ClientSetTVStandard | 4.4.4 |
| Mpg24Net_ClientSetResolution | 4.4.5 |
| Mpg24Net_ClientSetFrameRate | 4.4.6 |
| Mpg24Net_ClientSetPreviewDisplay | 4.4.7 |
| Mpg24Net_ClientGetConnectionStatus | 4.4.8 |
| Mpg24Net_ClientStartPreview | 4.4.9 |
| Mpg24Net_ClientStartSave | 4.4.10 |
| Mpg24Net_ClientStop | 4.4.11 |
| Mpg24Net_ClientPreviewShow | 4.4.12 |
| Mpg24Net_GetLastErrorInfo | 4.5 |
# 4.3 Server functions
# 4.3.1 Mpg24Net\_ServerOpen
This function will open a new server instance. A server instance is a network server that waits for client connections (unicast), or sends stream data to the same network group of receivers (multicast).
# Syntax
```txt
int Mpg24Net_ServerOpen(
int StreamType = 0
);
```
# Parameters
# StreamType
Specifies the type of the network streaming. It could be:
0: Unicast (TCP). Point to point communication.
1: Multicast (UDP). Group broadcast communication.
# Return Values
Handle of server instance if return value is greater than or equal to 0. Or an error code if return value is negative. See chapter 4.5 for the error code.
# 4.3.2 Mpg24Net\_ServerClose
This function will close a server instance. A server instance is a network server that waits for client connections (unicast), or sends stream data to the same network group of receivers (multicast).
# Syntax
```txt
int Mpg24Net_ServerClose(
int hHandle
);
```
# Parameters
hHandle
Specifies the handle of the server instance.
Return Values
See chapter 4.5.
# 4.3.3 Mpg24Net\_ServerStart
This function will start a server. The server will open a network socket and wait for client connections (unicast), or send stream data over the network (multicast). If the stream type is unicast, a server instance has a maximum of 16 concurrent connections.
# Syntax
```txt
int Mpg24Net_ServerStart(
int hHandle,
short port,
char *ServerIp = ""
);
```
# Parameters
# hHandle
Specifies the handle of the server instance.
# Port
Specifies the port number.
# ServerIp
Specifies the IP address, in network order (bytes ordered from left to right). You can leave it blank for unicast type.
# Return Values
See chapter 4.5.
# 4.3.4 Mpg24Net\_ServerStop
This function can be used to stop a server. The server will close a network socket and close all client connections.
# Syntax
```txt
int Mpg24Net_ServerStop(
int hHandle
);
```
# Parameters
hHandle
Specifies the handle of the server instance.
# Return Values
See chapter 4.5.
# 4.3.5 Mpg24Net\_ServerSend
This function can be used to send stream data to all clients. The stream data comes from external library (callback function of PCI\_MPG24.dll).
# Syntax
```txt
int Mpg24Net_ServerSend(
int hHandle,
BYTE * pBuffer,
int iBufferSize,
int iSyncPoint
);
```
# Parameters
# hHandle
Specifies the handle of the server instance.
# pBuffer
Specifies the buffer pointer of stream data.
# iBufferSize
Specifies the size of stream data.
# iSyncPoint
Specifies whether the stream data is a key frame (I frame). Its value could be:
0: Key frame (I frame)
1: Other frame (P frame or B frame)
# Return Values
See chapter 4.5.
# Example
Below is a server sample which functions open a unicast server instance and which send data to all clients.
```c
#include "PCI_MPG24.h"
#include "Mpg24Net.h"
int hHandle;
```
```txt
void __stdcall MyCallbackProc(
BYTE * pBuffer,
int iBufferSize,
int iSyncPoint
)
{
if(iBufferSize>0 && pBuffer)
Mpg24Net_ServerSend(
hHandle,
pBuffer,
iBufferSize,
iSyncPoint
);
}
start()
{
// Open ADLink Hardware MPEG4 Device
Mpg24_EncoderOpen(0, 0);
// Set configuration: NTSC Full D1 30fps
4Mbps Microsoft MPEG-4
Mpg24_EncoderSetVideoFormat(0, 0,
VideoFormat_Standard, 0);
Mpg24_EncoderSetVideoFormat(0, 0,
VideoFormat_Size, 0);
Mpg24_EncoderSetVideoFormat(0, 0,
VideoFormat_FrameRate, 0);
Mpg24_EncoderSetVideoFormat(0, 0,
VideoFormat_TargetBitrate, 0);
Mpg24_EncoderSetVideoFormat(0, 0,
VideoFormat_SubType, 0);
Mpg24_EncoderSetVideoFormat(0, 0,
VideoFormat_MPEG4Mode, 1);
Mpg24_EncoderCallback(0, 0,
MyCallbackProc);
// Open a server instance
hHandle = Mpg24Net_ServerOpen(0);
// Start
Mpg24Net_ServerStart(hHandle, 5000);
Mpg24_EncoderRun(0, 0);
}
```
# 4.4 Client functions
# 4.4.1 Mpg24Net\_ClientOpen
This function will open a new client instance. A client instance is a network client that connects to a server (unicast), or joins a network group (multicast).
# Syntax
```txt
int Mpg24Net_ClientOpen(
int StreamType = 0
);
```
# Parameters
# StreamType
Specifies the type of the network streaming. It could be:
0: Unicast (TCP), point to point communication.
1: Multicast (UDP), group broadcast communication.
# Return Values
Handle of client instance if return value is greater than or equal to 0. Or an error code if return value is negative. See chapter 4.5 for the error code.
# 4.4.2 Mpg24Net\_ClientClose
This function will close the client instance. A client instance is a network client that connects to a server (unicast), or joins a network group (multicast).
# Syntax
```c
int Mpg24Net_ClientClose (int hHandle);
```
# Parameters
# hHandle
Specifies the handle of the client instance.
# Return Values
Handle of client instance if return value is greater than or equal to 0. Or an error code if return value is negative. See chapter 4.5 for the error code.
# 4.4.3 Mpg24Net\_ClientSetSubType
Specifies the video subtype.
# Syntax
```txt
int Mpg24Net_ClientSetSubType (
int hHandle,
int iSubType
);
```
# Parameters
hHandle
Specifies the handle of the client instance.
iSubType
Specifies the video subtype. It could be:
0: DivX MPEG-4(need DivX V5.x)
1: Motion JPEG
2: Microsoft MPEG-4 (default)
3: MPEG-2 (Need third-party MPEG-2 DirectShow software, such as InterVideo, Elecard, Nero..., etc.)
# Return Values
See chapter 4.5.
# 4.4.4 Mpg24Net\_ClientSetTVStandard
Specifies the TV standard.
# Syntax
```txt
int Mpg24Net_ClientSetTVStandard (
int hHandle,
int iTVStandard
);
```
# Parameters
hHandle
Specifies the handle of the client instance.
iTVStandard
Specifies the TV standard. It could be:
0: NTSC
1: PAL
# Return Values
See chapter 4.5.
# 4.4.5 Mpg24Net\_ClientSetResolution
This function will specify the specific resolution (width and height of video).
# Syntax
```txt
int Mpg24Net_ClientSetResolution (
int hHandle,
int iResolution
);
```
# Parameters
# hHandle
Specifies the handle of the client instance.
# iResolution
Specifies the specific resolution. It depends on the value of the TV standard. It could be:
TV Standard = NTSC
0: Full D1 (720x480)
1: CIF (352x240)
2: QCIF (176x144)
3: VGA (640x480)
4: QVGA (320x240)
TV Standard = PAL
0: Full D1 (720x576)
1: CIF (352x288)
2: QCIF (176x144)
3: VGA (640x480)
# Return Values
See chapter 4.5.
# 4.4.6 Mpg24Net\_ClientSetFrameRate
Specifies the specific frame rate.
# Syntax
```txt
int Mpg24Net_ClientSetFrameRate (
int hHandle,
int iFrameRate
);
```
# Parameters
hHandle
Specifies the handle of the client instance.
iResolution
Specifies the specific frame rate which is dependant upon the value of the TV standard. It could be:
TV Standard = NTSC
0: 29.97 fps
1: 15 fps
2: 10 fps
3: 5 fps
4: 1 fps
TV Standard = PAL
0: 25 fps
1: 12.5 fps
2: 8.3 fps
3: 5 fps
4: 1 fps
# Return Values
See chapter 4.5.
# 4.4.7 Mpg24Net\_ClientSetPreviewDisplay
Specifies the configuration of preview window.
# Syntax
```txt
int Mpg24Net_ClientSetPreviewDisplay (
int hHandle,
int hWnd,
int Left,
int Top,
int Width,
int Height,
int AutoShow
);
```
# Parameters
# hHandle
Specifies the handle of the client instance.
# hwnd
Specifies the handle of a parent window for the video window. The video images will overlay on this window. Setting it to null will create a new window and display the video images on it.
# Left
Specifies the x-coordinate of the video window.
# Top
Specifies the Y-coordinate of the video window.
# Width
Specifies the width of the video window.
# Height
Specifies the height of the video window.
# AutoShow
Specifies whether the video renderer automatically shows the video window when it receives video data.
# Return Values
See chapter 4.5.
# 4.4.8 Mpg24Net\_ClientGetConnectionStatus
This function can be used to retrieve the connection status either to the server (unicast), or a network group multicast).
# Syntax
```txt
int Mpg24Net_ClientGetConnectionStatus(int hHandle);
```
# Parameters
hHandle
Specifies the handle of the client instance.
# Return Values
0: Disconnected
1: Connected
Others: Error occurs. See chapter 4.5.
# 4.4.9 Mpg24Net\_ClientStartPreview
This function will start a client preview of a video graph. The client will open a network socket and establish a connection with the server (unicast), or it will join a network (multicast).
# Syntax
```txt
int Mpg24Net_ClientStartPreview(
int hHandle,
char *ServerIp,
short port
);
```
# Parameters
# hHandle
Specifies the handle of the client instance.
# ServerIp
Specifies the IP addres, in network order (bytes ordered from left to right). For unicast, the IP address will be the IP address of the server. For multicast, the IP address is same as the parameter 'ServerIp' of Mpg24Net\_ServerOpen().
# Port
Specifies the port number that is same as the parameter 'port' of Mpg24Net\_ServerOpen().
# Return Values
See chapter 4.5.
Note: If MPEG-2 sub type is selected, you must install a third-party MPEG-2 decoder.
# 4.4.10 Mpg24Net\_ClientStartSave
This function can be used to start a client. The client will open a network socket and establish a connection with the server (unicast), or join a network (multicast). This function also receives the stream data and saves them to a media file.
# Syntax
```txt
int Mpg24Net_ClientStartSave(
int hHandle,
char *ServerIp,
short port,
char *Filename
);
```
# Parameters
# hHandle
Specifies the handle of the client instance.
# ServerIp
Specifies the IP address in network order (bytes ordered from left to right). For unicast, the IP address will be the IP address of the server. For multicast, the IP address is same as the parameter 'ServerIp' of Mpg24Net\_ServerOpen().
# Port
Specifies the port number that is same as the parameter 'port' of Mpg24Net\_ServerOpen().
# Filename
Specifies the media file name. Usually the file extension of MPEG-4 and Motion JPEG is 'avi'.
Note: We don't support MPEG-2 subtype for file saving.
# 4.4.11 Mpg24Net\_ClientStop
Stop a client. The client will close a network socket and terminate the server connection (unicast) or leave the network (multicast).
# Syntax
```txt
int Mpg24Net_ClientStop(
int hHandle
);
```
# Parameters
hHandle
Specifies the handle of the client instance.
Return Values
See chapter 4.5.
# 4.4.12 Mpg24Net\_ClientPreviewShow
This function can be used to show or hide the preview graph.
# Syntax
```txt
int Mpg24Net_ClientPreviewShow(
int hHandle,
short Visible
);
```
# Parameters
hHandle
Specifies the handle of the client instance.
Visible
Specifies whether the preview graph is shown. It could be:
```yaml
0: Invisible
1: Visible
```
# Return Values
See chapter 4.5.
# 4.5 Error Codes
Mpg24Net\_GetLastErrorInfo
Use this function to get an error message of last error.
# Syntax
```txt
Int Mpg24Net_GetLastErrorInfo(
TCHAR *ErrorInfo
);
```
# Parameters
# ErrorInfo
Specifies the pointer of a text buffer for storing the error message. Users need to allocate a buffer space enough to get this error message (max. 256 bytes).
All error codes are listed below:
| Error Name | Value | Description |
| S_OK | 0 | Success |
| Mpg24Net_INSUFFICIENT_MEMORY | -1 | Insufficient memory |
| Mpg24Net_INVALID_HANDLE | -2 | Invalid handle number |
| Mpg24Net_INSTANCE_NOT_OPEN | -3 | Instance has not been opened |
| Mpg24Net_INSTANCE_EXCEED | -4 | Exceeds the maximum instance |
| Mpg24Net_INVALID_PORT | -5 | Invalid port number |
| Mpg24Net_FILTER_NOT_REGISTER | -6 | dsnet.ax or dsnet_mcast.ax has not been registered |
| Mpg24Net_INTERFACE_ERROR | -7 | The interface of ADLINK Unicast/Multicast Sender/Receiver error |
| Mpg24Net_DECODER_NOT_INSTALL | -8 | DivX decoder, MJPEG decompressor, Microsoft MPEG-4 video decompressor, or MPEG-2 decoder has not been installed |
| Mpg24Net_DIRECTX_ERROR | -9 | An error message comes form DirectX |
| Mpg24Net_INVALID_PARAMETER | -10 | Input parameters exceed allowable range |
| Mpg24Net_NOT_STOPPED | -11 | Invalid operation while running |
# Warranty Policy
Thank you for choosing ADLINK. To understand your rights and enjoy all the after-sales services we offer, please read the following carefully.
1. Before using ADLINK's products please read the user manual and follow the instructions exactly. When sending in damaged products for repair, please attach an RMA application form which can be downloaded from: http://rma.adlinktech.com/policy/.
2. All ADLINK products come with a limited two-year warranty, one year for products bought in China:
The warranty period starts on the day the product is shipped from ADLINK's factory.
▶ Peripherals and third-party products not manufactured by ADLINK will be covered by the original manufacturers' warranty.
For products containing storage devices (hard drives, flash cards, etc.), please back up your data before sending them for repair. ADLINK is not responsible for any loss of data.
▶ Please ensure the use of properly licensed software with our systems. ADLINK does not condone the use of pirated software and will not service systems using such software. ADLINK will not be held legally responsible for products shipped with unlicensed software installed by the user.
For general repairs, please do not include peripheral accessories. If peripherals need to be included, be certain to specify which items you sent on the RMA Request & Confirmation Form. ADLINK is not responsible for items not listed on the RMA Request & Confirmation Form.
3. Our repair service is not covered by ADLINK's guarantee in the following situations:
▶ Damage caused by not following instructions in the User's Manual.
▶ Damage caused by carelessness on the user's part during product transportation.
▶ Damage caused by fire, earthquakes, floods, lightening, pollution, other acts of God, and/or incorrect usage of voltage transformers.
▶ Damage caused by unsuitable storage environments (i.e. high temperatures, high humidity, or volatile chemicals).
▶ Damage caused by leakage of battery fluid during or after change of batteries by customer/user.
▶ Damage from improper repair by unauthorized ADLINK technicians.
▶ Products with altered and/or damaged serial numbers are not entitled to our service.
▶ This warranty is not transferable or extendible.
▶ Other categories not protected under our warranty.
4. Customers are responsible for shipping costs to transport damaged products to our company or sales office.
5. To ensure the speed and quality of product repair, please download an RMA application form from our company website: http://rma.adlinktech.com/policy. Damaged products with attached RMA forms receive priority.
If you have any further questions, please email our FAE staff: service@adlinktech.com.
[🔗 Link to the original document](.pci-mpg24-manual-12/pci-mpg24-manual-12.pdf)