ReceiveFax
ReceiveFax |
|
|
This control provides the ability to receive one or more faxes while performing voice processing on a channel in VBVoice. It can either receive the fax on a separate call, or on the voice call depending on fax server type.
When a fax is received, a VBFaxJob object is created, and a single document is added to the Documents collection, which identifies the filename of the received fax.
(Boolean)
This property is not used.
(String)
The filename to the default document file to be received by the ReceiveFax control. This may also be a VBVoice %..% property name referring to a property in another control. The fax will be received as a TIFF file.
The file can be a complete path or a path relative to the default faxin directory, set by the FaxPathIn ini setting, default C:\Program Files\Pronexus\VBVoice\faxin. The filename may also contain an asterisk, such as myfax*.tif, in which case the * will be replaced by a random number which will generate a unique file name.
(String)
Used to set the CSID of the recipient of a fax when using same-call only. In this case the CSID is the CSID sent to the transmitting fax, and will appear on the remote CSID display. The incoming CSID or the remote machine is retrieved from SenderStationID. If you wish to change the CSID for each fax, use the StationID of the first recipient in the CurrentJob object.
All the runtime properties below are indexed by Channel unless otherwise specified.
(Channel as Integer)
This property contains the current fax job for each channel. This is an array of VBFaxJob objects. See the Object Reference for details on using the object returned by this property. This property is available in the Enter event for this control. After the call terminates, the current job will contain information about the received fax. To retain a reference to the job, assign the CurrentJob(Channel) value to a variable during the Exit event. This job may be referred to through this variable after the call is completed.
The Documents collection will contain a single document, containing information about the fax. The Sender object will contain the CSID of the sender, and the number of the calling fax machine if available from incoming caller id.
(Integer)
The duration in seconds of the fax transmission. This time does not include the time spent in voice mode before the fax transmission starts.
(Channel as Integer) as vbvIPFaxTypeConstants
HMP is capable of originating and receiving a fax using a V.17 soft modem. This facility can be used for routing the V.17 PCM data over a G.711 coder in a "fax pass-through" mode. This is recommended only on local area networks or on specialized VoIP networks.
The default is T.38 fax (vbvIPFaxTypeT38). The type of the fax could be changed only in the Enter event.
Example:
Private Sub ReceiveFax1_Enter(ByVal channel As Integer)
ReceiveFax1.IPFaxType(channel) = vbvIPFaxTypeG711
End Sub
(FaxStatusConstants, read-only)
The current state of the last receive operation for each channel.
(String, read-only)
An additional text description of the state of the last receive operation for each channel. This property is used to provide informational messages back to the user.
(FaxStatusReasonConstants, read-only)
JobStatusReason provides additional information on why a receive operation failed.
(String, read-only)
An additional text description of the JobStatusReason code.
(Integer)
The number of pages in the received fax.
(String)
The filename of the received fax. This filename is created using the Filename property.
(String)
This property retrieves the CSID of the sending fax. It is valid after the fax has been received.
(Integer)
The transmission rate in bits-per-second used by the fax connection.
(VBFaxDocuments collection)
The collection of documents attached to the current job. Use this property to add one or more file attachments to the current fax job.
Enter(ByVal Channel as Integer)
The Enter event is fired when the flow of control passes from another control to the topmost input node of the ReceiveFax control.
Exit(ByVal node as Integer)