diff options
| author | b5f0d6c3 <[email protected]> | 2021-10-22 00:23:40 +0800 |
|---|---|---|
| committer | b5f0d6c3 <[email protected]> | 2021-10-22 00:23:40 +0800 |
| commit | 8bdba34fc009ada8109e47507bdbc2dbd076c1d2 (patch) | |
| tree | 6faa6d8d4071bf6f04c1b8b9663e9a4502d82605 /mkvlib/c | |
| parent | f21da8d71e54bc5acaada1c25bcf6b5f0d674e83 (diff) | |
update README.md (sdk)
Diffstat (limited to 'mkvlib/c')
| -rw-r--r-- | mkvlib/c/README.md | 75 |
1 files changed, 71 insertions, 4 deletions
diff --git a/mkvlib/c/README.md b/mkvlib/c/README.md index 14038cb..74a0f4c 100644 --- a/mkvlib/c/README.md +++ b/mkvlib/c/README.md @@ -14,7 +14,7 @@ - *InitInstance(logCallbac lcb)* - 应该被最先调用. - 会检测依赖,如果不满足会返回false. -- 如果在未调用本函数的情况下调用其他函数会永远返回失败状态. +- 如果在**未**或**未成功**调用本函数的情况下调用其他函数会永远返回失败状态. ### 查询相关 - ```c @@ -24,14 +24,81 @@ //return: json格式的文件信息,如果出错会返回"null". ``` - ```c - char* CheckSubset(char* file,logCallbac lcb); + char* CheckSubset(char* file, logCallbac lcb); //查询一个mkv文件是否需要子集化操作 //file: mkv文件路径 //return: 包含是否已子集化和是否出错两个bool成员的json文本. ``` - ```c - char* QueryFolder(char* dir,logCallbac lcb); + char* QueryFolder(char* dir, logCallbac lcb); //查询一个文件夹里的mkv文件是否需要子集化 //dir: 文件夹路径 //return: 需要子集化的mkv文件路径数组 - ```
\ No newline at end of file + ``` +### MKV相关 +- ```c + bool DumpMKV(char* file, char* output, bool subset, logCallback lcb); + //抽取一个mkv文件里的字幕和字体并顺便进行子集化(可选) + //file: mkv文件路径 + //output: 输出文件夹路径 + //subset: 是否进行子集化 + //return: 是否全程无错 + ``` +- ```c + bool DumpMKVs(char* dir, char* output, bool subset, logCallback lcb); + //抽取一个文件夹里的mkv的字幕和字体并顺便进行子集化(可选) + //dir: 文件夹路径 + //output: 输出文件夹路径 + //subset: 是否进行子集化 + //return: 是否全程无错 + ``` + - 输出文件夹的目录结构请参考[这里](https://github.com/KurenaiRyu/MkvAutoSubset#mkvtool-%E5%8A%9F%E8%83%BD%E5%8F%8A%E4%BD%BF%E7%94%A8%E7%A4%BA%E4%BE%8B). +- ```c + bool CreateMKV(char* file, char* tracks, char* attachments, char* output, char* slang, char* stitle, bool clean); + //将字幕和字体封进mkv文件 + //file: 源mkv文件路径 + //tracks: 字幕文件路径数组的json化文本 + //attachments: 字体文件路径数组的json化文本 + //output: 输出文件路径 + //slang: 默认字幕语言 + //stitle: 默认字幕标题 + //clean: 是否清除源mkv原有的字幕和字体 + //return: 是否全程无错 + ``` + - 关于字幕的命名方式请参考[这里](https://github.com/KurenaiRyu/MkvAutoSubset#%E4%B8%80%E4%BA%9B%E7%A2%8E%E7%A2%8E%E5%BF%B5) +- ```c + bool CreateMKVs(char* vDir, char* sDir, char* fDir, char* tDir, char* oDir, char* slang, char* stitle, bool clean, logCallback lcb); + //从一组文件夹获得情报自动生成一组mkv并自动进行子集化操作 + //vDir: 视频文件夹路径 + //sDir: 字幕文件夹路径 + //fDir: 字体文件夹路径 + //tDir: 子集化数据临时存放文件夹路径(如果为空字符串则自动指定到系统临时文件夹如"/tmp") + //oDir: 成品输出文件夹路径 + //slang: 默认字幕语言 + //stitle: 默认字幕标题 + //clean: 是否清除源mkv原有的字幕和字体 + //return: 是否全程无错 + ``` + - 关于字幕的命名方式请参考[这里](https://github.com/KurenaiRyu/MkvAutoSubset#%E4%B8%80%E4%BA%9B%E7%A2%8E%E7%A2%8E%E5%BF%B5) +- ```c + bool MakeMKVs(char* dir, char* data, char* output, char* slang, char* stitle, logCallback lcb); + //用子集化后的数据目录替代原有的字幕和字体 + //dir: 源mkv集合文件夹路径 + //data: 子集化后的数据文件夹路径 + //output: 新mkv集合输出文件夹路径 + //slang: 默认字幕语言 + //stitle: 默认字幕标题 + //return: 是否全程无错 + ``` + - 输出文件夹的目录结构请参考[这里](https://github.com/KurenaiRyu/MkvAutoSubset#mkvtool-%E5%8A%9F%E8%83%BD%E5%8F%8A%E4%BD%BF%E7%94%A8%E7%A4%BA%E4%BE%8B). + - 关于字幕的命名方式请参考[这里](https://github.com/KurenaiRyu/MkvAutoSubset#%E4%B8%80%E4%BA%9B%E7%A2%8E%E7%A2%8E%E5%BF%B5) +### 字幕相关 + - ```c + bool ASSFontSubset(char* files, char* fonts, char* output, bool dirSafe, logCallback lcb); + //对字幕和字体进行子集化操作 + //files: 字幕文件路径数组的json化文本 + //fonts: 字体文件夹路径 + //output: 成品输出文件夹路径 + //dirSafe: 是否把成品输出到"${output}/subsetted"文件夹里(为了安全建议设置为true) + //return: 是否全程无错 + ```
\ No newline at end of file |
