FTP Information¶
CrFTPServerSetting¶
Class describing FTP server setting info.
Member Variables
Name |
Type ([1]) |
Summary |
|---|---|---|
serverId |
CrInt16u |
Server ID |
displayName |
CrInt8u* (9:nullptr-11) |
Display string. Optional. |
serviceType |
CrFTPServerServiceType |
Type of Server service type |
hostName |
CrInt8u* (256:4-258) |
FTP server host name |
portNumber |
CrInt16u |
FTP server port number |
userName |
CrInt8u* (65:4-67) |
FTP server access user name |
passwordExists |
CrFTPServerPasswordExists |
Whether a password exists or not |
password |
CrInt8u* (65:nullptr-67) |
Password, Optional |
passiveMode |
CrFTPServerPassiveMode |
Passive mode |
destinationDir |
CrInt8u* (129:nullptr-131) |
Destination directory, Optional |
secureProtocol |
CrFTPServerUsingSecureProtocol |
Whether to use safety secure protocol |
directoryHierarchyType |
CrFTPServerDirectoryHierarchyType |
Handling of destination directory hierarchy |
overwriteType |
CrFTPServerSameNameFileOverwriteType |
Handling of same name file |
rootCertificateErrorSetting |
CrFTPServerRootCertificateErrorSetting |
Handling of root certificate error |
Footnotes
Member Functions
Signature |
Description |
|---|---|
Constructor |
String argument must not contain size information. |
Destructor |
- |
Copy Constructor |
- |
const char* GetDisplayName() |
Get the displayName. |
const char* GetHostName() |
Get the hostName. |
const char* GetUserName_() |
Get the userName. |
const char* GetPassword() |
Get the password. |
const char* GetDestinationDir() |
Get the destinationDir. |
CrFTPServerServiceType¶
Enumerate the kind of FTP server service type.
Member Enumerations
Definition |
Summary |
|---|---|
CrFTPServerServiceType_Invalid |
Invalid |
CrFTPServerServiceType_FTP |
FTP |
CrFTPServerPasswordExists¶
Enumerate the kind of using password.
Member Enumerations
Definition |
Summary |
|---|---|
CrFTPServerPassword_NotUse |
Not use |
CrFTPServerPassword_Use |
Use |
CrFTPServerPassiveMode¶
Enumerate the kind of passive mode.
Member Enumerations
Definition |
Summary |
|---|---|
CrFTPServerPassiveMode_Invalid |
Invalid |
CrFTPServerPassiveMode_Off |
Off |
CrFTPServerPassiveMode_On |
On |
CrFTPServerUsingSecureProtocol¶
Enumerate the kind of secure type.
Member Enumerations
Definition |
Summary |
|---|---|
CrFTPServerUsingSecureProtocol_Invalid |
Invalid |
CrFTPServerUsingSecureProtocol_Off |
Off |
CrFTPServerUsingSecureProtocol_On_FTPS
(OLD CrFTPServerUsingSecureProtocol_On)
|
On: FTPS |
CrFTPServerUsingSecureProtocol_On_SFTP |
On: SFTP |
CrFTPServerDirectoryHierarchyType¶
Enumerate the kind of FTP server directory hierarchy type.
Member Enumerations
Definition |
Summary |
|---|---|
CrFTPServerDirectoryHierarchyType_Invalid |
Invalid |
CrFTPServerDirectoryHierarchyType_Standard |
Standard |
CrFTPServerDirectoryHierarchyType_SameAsInCamera |
Same as in camera |
CrFTPServerSameNameFileOverwriteType¶
Enumerate the kind of overwrite type.
Member Enumerations
Definition |
Summary |
|---|---|
CrFTPServerSameNameFileOverwriteType_Invalid |
Invalid |
CrFTPServerSameNameFileOverwriteType_Overwrite |
Overwrite |
CrFTPServerSameNameFileOverwriteType_NotOverwrite |
Not overwrite |
CrFTPServerRootCertificateErrorSetting¶
Enumerate the kind of root certificate type.
Member Enumerations
Definition |
Summary |
|---|---|
CrFTPServerRootCertificateErrorSetting_Invalid |
Invalid |
CrFTPServerRootCertificateErrorSetting_Connect |
Connect |
CrFTPServerRootCertificateErrorSetting_NotConnect |
Not connect |
CrFTPJobInfo¶
Class describing FTP Job info.
Class for checking information on FTP Jobs registered using ControlFTPJobList(), which can be obtained with GetFTPJobList().
Further FTP Jobs can be controlled according to the status of FTP Jobs registered with ControlFTPJobList(). For example, you can suspension of content transfer in transit by specifying CrFTPJobControlType_Suspend to ControlFTPJobList(). See “Control the FTP Jobs” for instructions on how to control FTP Jobs.
Member Variables
Name |
Type |
Summary |
|---|---|---|
serverId |
CrInt32u |
Server ID |
jobId |
CrInt32u |
Job ID |
slotId |
CrFTPJobSlotId |
Media SLOT number |
jobStatus |
CrFTPJobStatus |
Job Status |
chunkNum |
CrInt32u |
Number of chunks
When transfer is complete : Total chunks
Transfer in process : Transfer complete chunks
|
fileSize |
CrInt64u |
File size |
transferSize |
CrInt64u |
Transferred size |
clipName |
CrInt8u* |
Destination file name (*1) |
mainName |
CrInt8u* |
Source file name (*1) |
metaName |
CrInt8u* |
Meta file name of the Source file (*1) |
*1 : The first 2 bytes are the number of characters including the null terminator. Basically fold back the file name set in CrFTPJobSetting class.
Member Functions
Signature |
Description |
|---|---|
Constructor |
- |
Destructor |
- |
Copy Constructor |
- |
const char* GetClipName() |
Get the clipName. |
const char* GetMainName() |
Get the mainName. |
const char* GetMetaName() |
Get the metaName. |
CrFTPJobSetting¶
Class describing FTP Job setting. This class is used in ControlFTPJobList().
Some member variables use content information obtained with GetMediaProfile().
See “Control the FTP Jobs” for instructions on how to control FTP Jobs.
Member Variables
| Name | Type (*1) | Required | Summary | |
|---|---|---|---|---|
| Original | Trim | |||
| trimType | CrFTPJobTrimType | ✓ | ✓ | Specify whether to transfer as trimmed or not |
| serverId | CrInt32u | ✓ | ✓ | Destination FTP Server ID |
| slotId | CrFTPJobSlotId | ✓ | ✓ | Source slot |
| clipPath |
CrInt8u* (129:4-131) |
✓ | ✓ | Source file name. Specify the Main content URL or Proxy content URL. |
| metaPath |
CrInt8u* (129:nullptr-131) |
- | - |
Meta file name. Optional. Valid when the clipPath member is the Main content URL. |
| transferDir |
CrInt8u* (513:nullptr-515) |
- | - | Transfer directory. Optional |
| inFrame | CrInt32u | - | ✓ | In point for Trim |
| outFrame | CrInt32u | - | ✓ | Out point for Trim |
| duration | CrInt32u | - | ✓ | Number of frames |
| destClipName |
CrInt8u* (129:nullptr-131) |
- | ✓ | Destination file name. Clip Name only, no extension required |
| umid | CrInt8u[32] | - | ✓ | UMID. null or 32byte fixed length |
| videoType |
CrInt8u* (129:nullptr-131) |
- | ✓ | Video codec type |
| compJobAction | CrFTPJobCompleteAction | - | - | Reserved |
| deleteJobAction | CrFTPJobDeleteAction | - | - | Reserved |
*1 : String member. Must be set to the number of characters including the null-terminator in the first 2 bytes. The value to the left in parentheses is the maximum number of characters including null terminators.And the right value of the colon is the minimum and maximum number of bytes for each member. If omitted, nullptr is fine. For example, when setting one character of ‘A’, the first 2 bytes + ‘A’ + null-terminator, totaling 4 bytes, should be prepared.
Member Functions
Signature |
Description |
|---|---|
Constructor |
String argument must not contain size information. |
Destructor |
- |
Copy Constructor |
- |
const char* GetClipPath() |
Get the clipPath. |
const char* GetMetaPath() |
Get the metaPath. |
const char* GetTransferDir() |
Get the transferDir. |
const char* GetDestClipName() |
Get the destClipName. |
const char* GetVideoType() |
Get the videoType. |
CrFTPJobControlType¶
Enumerate the kind of FTP Job control.
Member Enumerations
Definition |
Summary |
|---|---|
CrFTPJobControlType_Add |
Adding FTP Jobs |
CrFTPJobControlType_Delete |
Deleting FTP Jobs |
CrFTPJobControlType_Suspend |
Suspension of FTP Jobs |
CrFTPJobControlType_Resume |
Resumption of FTP Jobs |
CrFTPJobTrimType¶
Enumerate the kind of trim.
Member Enumerations
Definition |
Summary |
|---|---|
CrFTPJobTrimType_NoTrim |
No trimmed (Default) |
CrFTPJobTrimType_Trim |
Trimmed |
CrFTPJobSlotId¶
Enumerate the kind of Media SLOT.
Member Enumerations
Definition |
Summary |
|---|---|
CrFTPJobSlotId_Invalid |
Invalid |
CrFTPJobSlotId_Slot1 |
Media SLOT1 |
CrFTPJobSlotId_Slot2 |
Media SLOT2 |
CrFTPJobSlotId_Slot3 |
Media SLOT3 |
CrFTPJobStatus¶
Enumerate the kind of FTP Job status.
Member Enumerations
Definition |
Summary |
|---|---|
CrFTPJobStatus_Invalid |
Invalid |
CrFTPJobStatus_Waiting |
Waiting |
CrFTPJobStatus_Transferring |
Transferring |
CrFTPJobStatus_Completed |
Completed |
CrFTPJobStatus_Aborted |
Aborted by user |
CrFTPJobStatus_OtherErr |
Other than the following errors |
CrFTPJobStatus_DestAuthFailed |
Authentication failed |
CrFTPJobStatus_ServerCapacityOver |
Capacity exceeded |
CrFTPJobStatus_FileAccessErr |
No file sent, source file inaccessible |
CrFTPJobStatus_DestCertErr |
Incorrect destination certificate format |
CrFTPJobStatus_MediaAccessErr |
No source media, no access to source media, etc. |
CrFTPJobStatus_DestConnErr |
Unable to resolve the Host Name of the forwarding destination, etc. |
CrFTPJobStatus_DestServerErr |
Incorrect settings on the destination server |
CrFTPJobStatus_UploadErr |
Upload failed |
CrFTPJobStatus_DestCertNotValid |
Before the start of the expiration date of the FTP server’s certificate |
CrFTPJobStatus_DestCertExpired |
Expired FTP server certificate, etc. |
CrFTPJobStatus_PASVNotSupport |
FTP server does not support Passive Mode |
CrFTPJobStatus_ChunkTransErr |
Chunk transfer failed |
CrFTPJobCompleteAction¶
Enumerate the kind of complete action for FTP Job.
Member Enumerations
Definition |
Summary |
|---|---|
CrFTPJobCompleteAction_Invalid |
Invalid |
CrFTPJobCompleteAction_NoAction |
No action |
CrFTPJobCompleteAction_DeleteFile |
Reserved |
CrFTPJobDeleteAction¶
Enumerate the kind of delete action for FTP Job.
Member Enumerations
Definition |
Summary |
|---|---|
CrFTPJobDeleteAction_Invalid |
Invalid |
CrFTPJobDeleteAction_NoAction |
No action |
CrFTPJobDeleteAction_DeleteFile |
Reserved |