createVideoMessageFromFullPath

Description

info

Create a video message. The SDK extracts video information based on the absolute path and creates the video message internally.

iOS

Function Prototype

Future<Message> createVideoMessageFromFullPath({
    required String videoPath,
    required String videoType,
    required int duration,
    required String snapshotPath,
    String? operationID,
  })

Input Parameters

Parameter Name	Parameter Type	Required	Description
videoPath	String	Yes	Absolute path
videoType	String	Yes	Video type
duration	int	Yes	Duration
snapshotPath	String	Yes	Video thumbnail path

Return Result

Name	Type	Description
~	Message	Success return

Code Example

   Message msg = await OpenIM.iMManager.messageManager.createVideoMessageFromFullPath(videoPath: videoPath, videoType: videoType, duration: duration, snapshotPath: snapshotPath);
    //todo

Android

Function Prototype

+ (OIMMessageInfo *)createVideoMessageFromFullPath:(NSString *)videoPath
                                         videoType:(NSString *)videoType
                                          duration:(NSInteger)duration
                                      snapshotPath:(NSString *)snapshotPath;

Input Parameters

Parameter Name	Parameter Type	Required	Description
videoPath	NSString	Yes	Absolute path
videoType	NSString	Yes	Video type
duration	NSInteger	Yes	Duration
snapshotPath	NSString	Yes	Video thumbnail path

Return Result

Name	Type	Description
message	OIMMessageInfo	Success return

Code Example

OIMMessageInfo *message = [OIMMessageInfo createVideoMessageFromFullPath:@"" videoType:@"" duration:1 snapshotPath:@""];

Flutter

Function Prototype

    public Message createVideoMessageFromFullPath(String videoPath, String videoType, long duration, String snapshotPath)

Input Parameters

Parameter Name	Parameter Type	Required	Description
videoPath	String	Yes	Absolute path
videoType	String	Yes	Video type
duration	int	Yes	Duration
snapshotPath	String	Yes	Video thumbnail path

Return Result

Name	Type	Description
~	Message	Success return

Code Example

       Message Message= OpenIMClient.getInstance().messageManager. createVideoMessageFromFullPath( videoPath,  videoType,  duration,  snapshotPath)

uni-app

Note

Only supported when called using ffi in electron.

On the Web side, it is recommended to use createVideoMessageByURL or createVideoMessageByFile.

Function Prototype

IMSDK.createVideoMessageFromFullPath({
  videoPath: string,
  videoType: string,
  duration: number,
  snapshotPath: string,
}, operationID?: string): Promise<WsResponse<MessageItem>>

Input Parameters

Parameter Name	Parameter Type	Required	Description
videoPath	string	Yes	Video file absolute path
videoType	string	Yes	Video type, usually the extension
duration	number	Yes	Duration
snapshotPath	string	Yes	Video thumbnail absolute path

Return Result

Parameter Name	Parameter Type	Description
Promise.then()	Promise<WsResponse<MessageItem>>	Success callback
Promise.catch()	Promise<WsResponse>	Failure callback

Code Example

import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render';
const { instance: IMSDK } = getWithRenderProcess();


IMSDK.createVideoMessageFromFullPath({
  videoPath: 'file://...',
  videoType: 'mp4',
  duration: 9,
  snapshotPath: 'file://...',
})
  .then(({ data }) => {
    // Call successful
  })
  .catch(({ errCode, errMsg }) => {
    // Call failed
  });

Browser/Electron/MiniProgram

Function Prototype

IMSDK.asyncApi('createVideoMessageFromFullPath', operationID: string, {
  videoPath: string,
  videoType: string,
  duration: number,
  snapshotPath: string,
}): Promise<MessageItem>

Input Parameters

Parameter Name	Parameter Type	Required	Description
operationID	string	Yes	Operation ID, used to pinpoint issues, keep unique, prefer time+random
videoPath	string	Yes	Video file absolute path
videoType	string	Yes	Video type, usually the extension
duration	number	Yes	Duration
snapshotPath	string	Yes	Video thumbnail absolute path

Return Result

Use the openim-uniapp-polyfill package to make the function Promise. When calling, you need to use then and catch to determine and handle success and failure callbacks.

Parameter Name	Parameter Type	Description
Promise.then()	Promise<MessageItem>	Success callback
Promise.catch()	Promise<CatchResponse>	Failure callback

Code Example

import IMSDK from 'openim-uniapp-polyfill';

IMSDK.asyncApi('createVideoMessageFromFullPath', IMSDK.uuid(), {
  videoPath: '',
  videoType: 'mp4',
  duration: 12,
  snapshotPath: '',
})
  .then((data) => {
    // Call successful
  })
  .catch(({ errCode, errMsg }) => {
    // Call failed
  });

React-Native

Function Prototype

OpenIMSDK.createVideoMessageFromFullPath({
  videoPath: string,
  videoType: string,
  duration: number,
  snapshotPath: string,
}, operationID?: string): Promise<MessageItem>

Input Parameters

Parameter Name	Parameter Type	Required	Description
videoPath	string	Yes	Video file absolute path
videoType	string	Yes	Video type, usually the extension
duration	number	Yes	Duration
snapshotPath	string	Yes	Video thumbnail absolute path
operationID	string	No	Operation ID, used to pinpoint issues, keep unique, prefer time+random

Return Result

Parameter Name	Parameter Type	Description
Promise.then()	Promise<MessageItem>	Success callback
Promise.catch()	Promise<OpenIMApiError>	Failure callback

Code Example

import OpenIMSDK from "@openim/rn-client-sdk";

OpenIMSDK.createVideoMessageFromFullPath({
  videoPath: '',
  videoType: 'mp4',
  duration: 12,
  snapshotPath: '',
})
  .then((data) => {
    // Call successful
  })
  .catch((error) => {
    // Call failed
  });

Unity

Function Prototype

public static Message CreateVideoMessageFromFullPath(string videoFullPath, string videoType, long duration, string snapshotFullPath);

Input Parameters

Parameter Name	Parameter Type	Required	Description
videoPath	string	Yes	Absolute path
videoType	string	Yes	Video type
duration	long	Yes	Duration
snapshotFullPath	string	Yes	Video thumbnail path

Return Result

Name	Type	Description
message	Message	Success return

Code Example

var msg = IMSDK.CreateVideoMessageFromFullPath(videoFullPath,videoType,duration,snapshotFullPath);