# BS Editor

# The overall structure and main labels of the project are as follows:

<?xml version="1.0" encoding="UTF-8"?>
<timelines>
  <timeline>
    <resources>
      <resource/><resource/>
    </resources>
    <videoTracks>
      <videoTrack>
        <videos>
          <video>
            <videoFxs>
              <videoFx>
                <fxParams>
                  <fxParam/><fxParam/>
                </fxParams>
              </videoFx><videoFx/>
            </videoFxs>
            <audioFxs>
              <audioFx/>
            </audioFxs>
          </video><video/>
        </videos>
        <transitions>
          <transition/><transition/>
        </transitions>
      </videoTrack><videoTrack/>
    </videoTracks>
    <audioTracks>
      <audioTrack/><audioTrack>
        <audios>
          <audio/><audio/>
        </audios>
      </audioTrack>
    </audioTracks>
    <timelineVideoFxTracks>
      <timelineVideoFxTrack/><timelineVideoFxTrack>
        <timelineVideoFx>
          <fxParams>
            <fxParam/><fxParam/>
          </fxParams>
        </timelineVideoFx>
      </timelineVideoFxTrack>
    </timelineVideoFxTracks>
    <captionTracks>
      <captionTrack>
        <caption/><caption/>
      </captionTrack>
    </captionTracks>
    <compoundCaptionTracks>
      <compoundCaptionTrack>
        <compoundCaption>
          <captionItem/><captionItem/>
        </compoundCaption><compoundCaption/>
      </compoundCaptionTrack>
    </compoundCaptionTracks>
    <stickerTracks>
      <stickerTrack>
        <sticker/><sticker/>
      </stickerTrack>
    </stickerTracks>
    <musicLyricsTracks>
      <musicLyricsTrack>
        <musicLyric/><musicLyric/>
      </musicLyricsTrack>
    </musicLyricsTracks>
  </timeline>
</timelines>

# Label and attribute description

#

The root tag of the project file, a collection of timelines, used to display multi-resolution timelines

The properties are as follows:

  1. output [string type] the timeline resolution of the synthesized film
#

a timeline

The properties are as follows:

  1. resWidth [integer type] the width of the timeline, 1.1. It needs to be a multiple of 4;
  2. resHeight [integer type] the height of the timeline, 2.1. It needs to be a multiple of 2;
  3. duration [long integer type] the duration of the timeline;
  4. videoSize [string type] the aspect ratio of the timeline;
  5. controlSpeed [floating point type] the preview speed of the "Frontend" timeline,
  6. noCaptions [Boolean type] Whether to not apply subtitles;
  7. sizeLevel [integer type] the resolution level of the synthesized film, 7.1. -1 means to use the default resolution of the timeline 7.2. 480, 720, 1080, and 2160 respectively represent the generation of slices with each as the short side
  8. Logo [Boolean type] Whether the synthesized film has a watermark
  9. outputStart [long integer type] the starting point position of interval export
  10. outputEnd [long integer type] the position of the end point of interval export
  11. enableRenderOrderByZValue [Boolean type] whether to enable the use of zValue as the rendering basis
  12. fps [integer type] frame rate 12.1. 24,25,30,50,60
  13. volume [floating point type] volume
  14. outputType [string type] format 14.1. Video: mp4,mov 14.2. Audio: m4a, mp3, mp4
  15. Whether nvenc [Boolean type] supports hard coding
  16. encoderMode [string type] cbr
  17. isShowSection【Boolean type】Whether the "Frontend" section display is a display
  18. sectionInPoint [long integer type] "Front end" interval display start point position
  19. sectionOutPoint [long integer type] "Front" section displays the position of the end point
  20. dbLimitValue [integer type] audio limiter
  21. videoBitrate [string type] bit rate 21.1. low, medium, high, 15000000, 30000000
  22. encoderType [string type] encoding 22.1. H.264, MPEG2-IBP
  23. scanMode [string type] scan mode 23.1. interlace interlaced scanning, progressive progressive scanning
  24. templateId [string type] template id Examples are as follows:
<timeline resWidth="960" resHeight="540" duration="15000000" videoSize="16:9" controlSpeed="1" trackCount="4" noCaptions="false" sizeLevel="-1"/>
#

A collection of video and audio resource files used in the project.

#

an audio-visual resource

The properties are as follows:

  1. id [string type] the unique identifier of the video and audio resources used;
  2. path [string type] the network path of the resource;
  3. reversePath [string type] the network path of the reverse resource; Examples are as follows:
<resource id="9623" path="" reversePath=""/>
#

A collection of video tracks.

#

a video track

The properties are as follows:

  1. index [integer type] the index of the track;
  2. volume [floating point type] the volume of the track; 2.1.0 Mute
  3. show [Boolean type] whether the track is hidden; Examples are as follows:
<videoTrack index="2" volume="0" show="true"/>
#

A collection of video clips.

#

a video clip

The properties are as follows

  1. id [string type] the unique identifier of the video resource used, 1.1. Corresponding to the id attribute value in the resource tag
  2. index [integer type] the index of the video segment;
  3. type [integer type] the type of video clip 3.1. 1 video, 3 pictures
  4. path [string type] the network path of the video file, 4.1. If there is a corresponding id in the resource, use the path in the resource when synthesizing
  5. m3u8Path [string type] "Frontend" The cache path of the m3u8 file in the frontend.
  6. m3u8Url [string type] the network path of the m3u8 file.
  7. reversePath [string type] the network path of the reverse video file, 7.1. If there is a corresponding id in the resource, use the path in the resource when synthesizing
  8. reverseM3u8Path [string type] "Frontend" The cache path of the m3u8 file of the reversed video in the frontend
  9. reverseM3u8Url [string type] reverse the network path of the video file,
  10. alphaPath [string type] the network path of the alpha channel file. 10.1. If there is a corresponding id in the resource, use the path in the resource when synthesizing
  11. alphaM3u8Path [string type] "Frontend" alpha channel m3u8 file cache path in the frontend.
  12. alphaM3u8Url [string type] the network path of the alpha channel m3u8 file.
  13. reverseAlphaPath [string type] the network path of the alpha channel m3u8 file. 13.1. If there is a corresponding id in the resource, use the path in the resource when synthesizing
  14. reverseAlphaM3u8Path [string type] The cache path of the m3u8 file of the alpha channel reversed by "Frontend" in the frontend.
  15. reverseAlphaM3u8Url [string type] the network path of the m3u8 file of the reversed alpha channel
  16. thumbnailHost [string type] the path prefix of the thumbnail of "Frontend"
  17. thumbnailStep [integer type] the interval of thumbnails in "Frontend"
  18. thumbnailType [string type] the type of thumbnail in "Frontend"
  19. orgReverseThumbnailHost [string type] the path prefix of the thumbnail of the reverse resource in "Frontend"
  20. trimIn【Long integer type】The trimming starting point of the video clip 20.1. The unit is microseconds;
  21. trimOut [long integer type] the trimming end point of the video clip 21.1. The unit is microseconds;
  22. inPoint [long integer type] the starting point of the video clip on the timeline 22.1. The unit is microseconds;
  23. outPoint [long integer type] the end point of the video clip on the timeline 23.1. The unit is microseconds;
  24. orgDuration [long integer type] the duration of the original resource file of the video clip 24.1. The unit is microseconds;
  25. volume [floating point type] the volume of the video clip;
  26. speed [floating point type] the speed of the video clip;
  27. bgBlur [Boolean type] Whether to use background blur for video clips;
  28. fadeInDuration [long integer type] the duration of the audio fade-in in the video clip, 28.1. The unit is microseconds;
  29. fadeOutDuration [long integer type] the duration of the audio fade out in the video clip, 29.1. The unit is microseconds;
  30. extraRotation [integer type] the rotation angle of the video clip;
  31. When noAudio [Boolean type] is true, the corresponding volume must be 0
  32. separated [Boolean type] Whether the video clip is separated from video and audio
  33. reverse [Boolean type] Whether the video clip is reversed;
  34. uuid [string type] the unique identifier of the fragment used by the front end of "Frontend"
  35. title [string type] the fragment name displayed in "Frontend";
  36. width [integer type] the width of the video resource
  37. height [integer type] the height of the video resource
  38. leftChannelUrl [string type] the network path of the left channel wave file of the video clip;
  39. rightChannelUrl [string type] the network path of the right channel wave file of the video clip;
  40. curvesSpeedName [string type] the title of the curve speed change of the video clip
  41. curvesSpeedString [string type] description of video segment curve speed change, 41.1. For the specific meaning, please refer to the relevant interface of the Meishe official website document: changeCurvesVariableSpeed
  42. blendingMode [integer type] blending mode
  43. fillMode [integer type] transformation mode
  44. enableClipFreezeFrame [Boolean type] is a negative frame
  45. freezeFrameTrimPos [long integer type] freeze frame position
  46. combination【Boolean type】Whether the "front end" is grouped
  47. combinationOrder [integer type] "front end" grouping number
  48. combination_template [string type] Whether to group when making templates in "Frontend"
  49. combinationOrder_template [integer type] grouping number when making templates in "Frontend"
  50. combination_template_type [string type] "front-end" grouping type when making templates
  51. useWebLocalFile【Boolean type】Whether "Frontend" is in local editing state

Examples are as follows:

<video id="9623" index="0" type="1" m3u8Path="" m3u8Url="" path="" alphaM3u8Path="" alphaM3u8Url="" alphaPath="" inPoint="0" outPoint="5000000" trimIn="0" trimOut="5000000" orgDuration="20000000" volume="1" speed="1" bgBlur="false" fadeInDuration="0" fadeOutDuration="0" extraRotation="0" reverse="false" noAudio="true" uuid="" title="" leftChannelUrl="" rightChannelUrl="" curvesSpeedString="(0,1)(-3,1)(3,1)(7,5)(6,5)(8,5)(10,0.4)(9,0.4)(11,0.4)(17,0.4)(16,0.4)(18,0.4)(20,5)(19,5)(21,5)(27,1)(24,1)(30,1)" enableClipFreezeFrame="true" freezeFrameTrimPos="2000000"/>
#

A collection of audio effects.

#

an audio effect

The properties are as follows:

  1. type [string type] the type of audio effect, 1.1. built-in special effect type, package package special effect type;
  2. id [string type] the ID of the audio effect package, 2.1. Valid when type is package;
  3. name [string type] the built-in name of the audio effect, 3.1. Valid when type is builtin;
  4. intensity [floating point type] the intensity of the audio effect;

Examples are as follows:

<audioFx index="0" type="builtin" name="Audio Noise Suppression"/>
#

A collection of video effects.

#

a video effect

The properties are as follows:

  1. type [string type] the type of video special effects, 1.1. built-in special effect type, package package special effect type;
  2. id [string type] the ID of the video effect package, 2.1. Valid when type is package;
  3. name [string type] the built-in name of the video effect, 3.1. Valid when type is builtin;
  4. videoFxType [string type] 4.1. animation, filter, effect
  5. animationType [string type] 5.1. inAnimation, loopAnimation
  6. isPostInAnimation [Boolean type]
  7. isPostOutAnimation [Boolean type]
  8. intensity [floating point type] the intensity of video special effects;
  9. isRaw [Boolean type]
  10. shape [string type] the shape displayed by the special effects in the "front end" area, 10.1. rect rectangle, ellipse ellipse;
  11. isRegional [Boolean type] whether to use a mask
  12. isIgnoreBackground [Boolean type]
  13. isInverseRegion [Boolean type]
  14. regionalFeatherWidth [floating point type] regional special effect edge feather width;
  15. clipSubType [string type] "front end"
  16. nvTypeId [string type] "front end"
  17. nvCategoryId [string type] "front end" Examples are as follows:
<videoFx index="0" type="builtin" name="Vignette" intensity="1">
#

A collection of video effects parameters.

#

A video effect parameter

The properties are as follows:

  1. type [string type] video special effect parameter type, 1.1. bool [Boolean type] 1.2. string [string type] 1.3. float [floating point type] 1.4. int [integer type] 1.5. object [object type] is mainly used for data structure, 1.5.1. For example, particle emitter path information, area information of area effects
  2. key [string type] the specific name of the video special effect parameter;
  3. value is the value of the video special effect parameter, and the value types of different types of parameters are different; Examples are as follows:
<fxParam type="float" key="Degree" value="0.18"/>
<fxParam type="bool" key="Stroke Only" value="false"/>
<fxParam type="string" key="Description String" value=""/>
<fxParam type="object" key="region">
  <objectValue x1="-0.5" y1="0.5" x2="-0.5" y2="-0.5" x3="0.5" y3="-0.5" x4="0.5" y4="0.5"/>
</fxParam>
<fxParam type="object" key="ellipseRegion">
	<objectValue centerX="0" centerY="0" a="0.5" b="0.5" angle="0"/>
</fxParam>
<fxParam type="object" key="curvePoint">
	<objectValue timeSec="0" x="-453.316162109375" y="-57.576847076416016"/>
</fxParam>
#

The value of the special effect parameter fxParam type when type is object

The properties are as follows:

  1. timeSec,x,y 1.1. The case of particle effects
  2. x1,x2,x3,x4,y1,y2,y3,y4 2.1. When the key of fxParam is region
  3. centerX, centerY, a, b, angle 3.1. When the key of fxParam is ellipseRegion
#

A collection of transitions.

#

a transition

The properties are as follows:

  1. index [integer type] the index value of the source segment of the transition;
  2. type [string type] the type of transition, 2.1. built-in transition type, package transition type;
  3. id [string type] the ID of the transition package, 3.1. Valid when type is package;
  4. name [string type] the built-in name of the transition, 4.1. Valid when type is builtin;
  5. duration [long integer type] the duration of the transition 5.1. The unit is microsecond; Examples are as follows:
<transition srcIndex=”0” defName="Fade"/>
#

A collection of audio tracks.

#

an audio track

The properties are as follows:

  1. index [integer type] the index of the track;
  2. volume [floating point type] the volume of the track;
  3. show [Boolean type] whether the track is hidden; Examples are as follows:
<audioTrack index="1" volume="1" show="true"/>
#

A collection of audio clips.

#

an audio clip

The properties are as follows:

  1. id [string type] the unique identifier of the audio resource used 1.1. Corresponding to the id attribute value in the resource tag
  2. index [integer type] the index of the audio clip;
  3. m3u8Path [string type] "Frontend" The cache path of the m3u8 file in the frontend.
  4. m3u8Url [string type] the network path of the m3u8 file.
  5. path [string type] the network path of the audio file, 5.1. If there is a corresponding id in the resource, use the path in the resource when synthesizing
  6. trimIn【Long integer type】The trimming starting point of the audio clip, 6.1. The unit is microsecond;
  7. trimOut [long integer type] the trimming end point of the audio clip, 7.1. The unit is microsecond;
  8. inPoint [long integer type] the starting point of the audio clip on the timeline, 8.1. The unit is microsecond;
  9. outPoint [long integer type] the end point of the audio clip on the timeline, 9.1. The unit is microsecond;
  10. orgDuration [long integer type] the duration of the original resource file of the audio clip
  11. volume [floating point type] the volume of the audio clip;
  12. speed [floating point type] the speed of the audio clip;
  13. fadeInDuration [long integer type] the duration of audio fade-in, 13.1. The unit is microseconds;
  14. fadeOutDuration [long integer type] the duration of audio fade out, 14.1. The unit is microseconds;
  15. uuid [string type] the unique identifier of the fragment used by the front end of "Frontend" 15.1. Only useful when correlating waveform data;
  16. title [string type] the fragment name displayed in "Frontend";
  17. leftChannelUrl [string type] the network path of the left channel wave file of the audio clip;
  18. rightChannelUrl [string type] the network path of the right channel wave file of the audio clip;
  19. audioStreamIndex [integer type] set which stream is used for multiple audio streams
  20. channelType [string type] channel type 20.1. stereo stereo, left left channel, right right channel
  21. combination【Boolean type】Whether "front end" is grouped
  22. combinationOrder [integer type] "front end" grouping order
  23. useWebLocalFile【Boolean type】Whether "Frontend" is in local editing state Examples are as follows:
<audio id="4010" index="0" m3u8Path="" m3u8Url="" path="" inPoint="0" outPoint="84080000" trimIn="0" trimOut="84080000" orgDuration="84080000" volume="1" speed="1" fadeInDuration="0" fadeOutDuration="0" uuid="" title="" leftChannelUrl="" rightChannelUrl=""/>
#

A collection of timeline effects tracks.

#

A timeline effects track

The properties are as follows:

  1. index [integer type] the index of the track;
  2. show [Boolean type] whether the track is hidden;
#

a timeline effect

The properties are as follows:

  1. index [integer type] the index of the timeline special effect;
  2. inPoint [long integer type] the starting point of the timeline effect on the timeline, 2.1. The unit is microsecond;
  3. duration [long integer type] the duration of the timeline special effect, 3.1. The unit is microsecond;
  4. type [string type] the type of timeline special effect, 4.1. built-in special effect type, package package special effect type;
  5. clipSubType [integer type] "Frontend" timeline special effect subtype;
  6. displayName [string type] the English name of the timeline special effect of "Frontend";
  7. displayNamezhCN [string type] the Chinese name of the timeline special effect of "Frontend";
  8. id [string type] ID of the timeline special effect package, 8.1. Valid when type is package;
  9. name [string type] the built-in name of the timeline effect, 9.1. Valid when type is builtin;
  10. intensity [floating point type] the intensity of timeline special effects;
  11. isRegional [Boolean type] whether it is a regional special effect;
  12. isIgnoreBackground [Boolean type] whether to ignore the background;
  13. isInverseRegion [Boolean type] whether to inversely select the region;
  14. regionalFeatherWidth [floating point type] regional special effect edge feather width;
  15. shape [string type] the shape displayed by the special effects in the "front end" area, 15.1. rect rectangle, ellipse ellipse;
  16. zValue [integer type] the level value of the timeline special effect;
  17. nvTypeId [string type] "front end"
  18. nvCategoryId [string type] "front end"
  19. combination【Boolean type】whether "Frontend" is grouped
  20. combinationOrder [integer type] "front end" grouping number Examples are as follows:
<timelineVideoFx index="0" inPoint="0" duration="5000000" type="package" clipSubType="201" displayName="retroGlare" displayNamezhCN="复古炫光" id="C4E478A7-157F-4A62-9524-229D84338F66" intensity="1" isRegional="false" isIgnoreBackground="false" isInverseRegion="false" regionalFeatherWidth="0" shape="rect"/>
#

A collection of subtitle tracks.

#

a subtitle track

The properties are as follows:

  1. index [integer type] the index of the track;
  2. show [Boolean type] whether the track is hidden;
#

a subtitle

The properties are as follows:

  1. index [integer type] the index of the subtitle;
  2. type [string type] subtitle type, 2.1. general general subtitles, modular modular subtitles;
  3. captionType [integer type] "Frontend" is used to distinguish subtypes of subtitles;
  4. uuid [string type] "front end"
  5. text [string type] subtitle text;
  6. inPoint [long integer type] the starting point of the subtitle on the timeline, 6.1. The unit is microsecond;
  7. duration [long integer type] subtitle duration, 7.1. The unit is microsecond;
  8. scaleX [floating point type] the horizontal scaling value of the subtitle;
  9. scaleY [floating point type] the vertical scaling value of the subtitle;
  10. rotation [floating point type] the rotation angle of the subtitle;
  11. recordingUserOperationTrans [Boolean type]
  12. translationX [floating point type] the horizontal movement value of the subtitle;
  13. translationY [floating point type] the vertical movement value of the subtitle;
  14. zValue [integer type] the level value of subtitles;
  15. font [string type] subtitle font;
  16. fontSize【floating point type】subtitle font size;
  17. fontSizeRatio [floating point type] the ratio of subtitle font size to timeline resolution;
  18. color [string type] subtitle text color, 18.1. Use #ffffffff color format, the order of color channels is a, r, g, b 18.2. All color values in the project are recorded in this form
  19. bold [Boolean type] Whether the subtitle is bold
  20. weight [integer type] the thickness of subtitles 20.1. Take effect when weight is greater than 0
  21. italic [Boolean type] Whether the subtitle is italic;
  22. underline [Boolean type] whether the subtitle is underlined;
  23. align [string type] subtitle text alignment, 23.1. Left is left-aligned, center is center-aligned, and right is right-aligned;
  24. shadow [Boolean type] Whether the subtitle has a shadow;
  25. shadowColor [string type] subtitle shadow color;
  26. shadowOffsetX [floating point type] the horizontal offset value of the subtitle shadow;
  27. shadowOffsetY [floating point type] the vertical offset value of the subtitle shadow;
  28. shadowFeather [floating point type] the feathering value of the subtitle shadow;
  29. outline [Boolean type] whether the subtitle has a shadow stroke;
  30. outlineColor [string type] subtitle stroke color;
  31. outlineWidth [floating point type] the width of the subtitle stroke;
  32. bgColor [string type] subtitle background color;
  33. bgRadius [floating point type] the radian of the subtitle background;
  34. styleId [string type] subtitle style ID 34.1. Can only be used for non-modular subtitles
  35. contextId [string type] module subtitle environment style package ID;
  36. rendererId [string type] module subtitle rendering style package ID;
  37. animationId [string type] module subtitle cycle animation style package ID 37.1. Cannot be used with in and out animations at the same time
  38. inAnimationId [string type] module subtitles into the animation style package ID;
  39. outAnimationId [string type] module subtitle out animation style package ID;
  40. animationPeroid [integer type] the period of the module subtitle cycle animation 40.1. The unit is milliseconds
  41. inAnimationDuration [integer type] the duration of module subtitles entering animation 41.1. The unit is milliseconds
  42. outAnimationDuration [integer type] the duration of the module subtitle animation 42.1. The unit is milliseconds
  43. letterSpacingType [integer type] word spacing type
  44. letterSpacing [integer type] word spacing value
  45. lineSpacing [integer type] line spacing value
  46. enableSpeed [Boolean type] Whether to enable animation adaptation
  47. combination【Boolean type】whether the "front end" is grouped
  48. combinationOrder [integer type] "front end" grouping number
  49. shape [string type] the shape displayed by the special effects in the "front end" area, 49.1. rect, ellipse;
  50. isRegional [Boolean type]
  51. isIgnoreBackground【Boolean type】
  52. isInverseRegion【Boolean type】
  53. regionalFeatherWidth [floating point type] regional special effect edge feather width; Examples are as follows:
<caption index="0" type="general" captionType="304" text="caption" inPoint="0" duration="5000000" scaleX="1" scaleY="1" rotation="0" translationX="0" translationY="0" zValue="4" font="Noto Sans CJK JP" fontSize="56" fontSizeRatio="0.1037037037037037" color="" bold="false" italic="false" align="center" shadow="false" outline="false" outlineColor="" outlineWidth="1" styleId="3C3EFA4C-90AF-4C80-A6A8-CD07F74A48AC"/>
#

A collection of combined subtitle tracks.

#

A combined subtitle track

The properties are as follows:

  1. index [integer type] the index of the track;
  2. show [Boolean type] whether the track is hidden;
#

a subtitle

The properties are as follows:

  1. index [integer type] the index of combined subtitles;
  2. inPoint [long integer type] the starting point of the composite subtitle on the timeline, 2.1. The unit is microsecond;
  3. duration [long integer type] combined subtitle duration, 3.1. The unit is microsecond;
  4. scaleX [floating point type] the horizontal scaling value of combined subtitles;
  5. scaleY [floating point type] the vertical scaling value of combined subtitles;
  6. rotation [floating point type] the rotation angle of combined subtitles;
  7. translationX [floating point type] the horizontal movement value of combined subtitles;
  8. translationY [floating point type] the vertical movement value of combined subtitles;
  9. zValue [integer type] the level value of combined subtitles;
  10. styleId [string type] Combined subtitle style ID;
  11. displayName [string type] the English name of the combination subtitle of "Frontend"
  12. displayNamezhCN [string type] Chinese name of combined subtitles in "Frontend"
  13. combination【Boolean type】whether "Frontend" is grouped
  14. combinationOrder [integer type] "front end" grouping number
#

A subtitle in a combined subtitle

The properties are as follows:

  1. index [integer type] the index of the subtitle;
  2. text [string type] subtitle text;
  3. font [string type] subtitle font;
  4. color [string type] subtitle text color; Examples are as follows:
<compoundCaption index="0" inPoint="0" duration="5000000" scaleX="1" scaleY="1" rotation="0" translationX="0" translationY="0" zValue="6" styleId="F91900FB-DABF-44A3-BEEB-5D73A3C84DD9"/>
  <captionItem index="0" text="April" font=" " color="#ffffffff"/>
  <captionItem index="1" text="Vlog" font="" color="#ffffffff"/>
  <captionItem index="2" text="四月小记" font="" color="#ffffffff"/>
</compoundCaption>
#

A collection of sticker tracks.

#

a sticker track

The properties are as follows:

  1. index [integer type] the index of the track;
  2. volume [floating point type] the volume of the track;
  3. show [Boolean type] whether the track is hidden;
#

a sticker

The properties are as follows:

  1. index [integer type] the index of the sticker;
  2. type [string type] the type of sticker, 2.1. general, regular stickers;
  3. inPoint [long integer type] the starting point of the sticker on the timeline, 3.1. The unit is microsecond;
  4. duration [long type] sticker duration, 4.1. The unit is microsecond;
  5. scaleX [floating point type] the horizontal scaling value of the sticker;
  6. scaleY [floating point type] the vertical scaling value of the sticker;
  7. rotation [floating point type] the rotation angle of the sticker;
  8. translationX [floating point type] the horizontal movement value of the sticker;
  9. translationY [floating point type] the vertical movement value of the sticker;
  10. horizontalFlip [Boolean type] whether the sticker is flipped horizontally;
  11. verticalFlip [Boolean type] whether the sticker is flipped vertically;
  12. zValue [integer type] the level value of the sticker;
  13. id [string type] the ID of the sticker pack;
  14. volume [floating point type] volume
  15. displayName [string type] the English name of the "front end" sticker
  16. displayNamezhCN [string type] Chinese name of the "front end" sticker
  17. uuid [string type] "front end"
  18. animationId [string type] sticker cycle animation style package ID
  19. inAnimationId [string type] sticker into the animation style package ID
  20. outAnimationId [string type] sticker out animation style package ID
  21. animationPeroid [integer type] the period of the sticker cycle animation 21.1. The unit is milliseconds
  22. inAnimationDuration [integer type] the duration of the sticker into the animation 22.1. The unit is milliseconds
  23. outAnimationDuration [integer type] the duration of the sticker animation 23.1. The unit is milliseconds
  24. combination【Boolean type】whether "Frontend" is grouped
  25. combinationOrder [integer type] "front end" grouping number
  26. path [string type] the network path of custom stickers Examples are as follows:
<sticker index="0" type="general " inPoint="9153846" duration="5000000" scale="1" rotation="90" translationX="-312.34" translationY="116.48" horizontalFlip="true" verticalFlip="false" zValue="6" id="B7B24515-86EE-460B-89C2-29689DA5AA9D"/>
#

A collection of lyric tracks. Note: Currently there is only one lyric track.

#

a lyric track

The properties are as follows:

  1. index [integer type] the index of the track;
  2. show [Boolean type] whether the track is hidden;
  3. scaleX [floating point type] the horizontal scaling value of the libretto;
  4. scaleY [floating point type] the vertical scaling value of libretto;
  5. rotation [floating point type] the rotation angle of libretto;
  6. translationX [floating point type] the horizontal movement value of libretto;
  7. translationY [floating point type] the vertical movement value of libretto;
  8. outline [Boolean type] Whether to enable strokes for libretto
  9. outlineWidth [floating point type] lyrics stroke width
  10. outlineColor [string type] the color of the lyrics stroke
  11. font [string type] libretto font;
  12. fontSize [floating point type] libretto font size;
  13. fontSizeRatio [floating point type] the ratio of libretto font size to timeline resolution;
  14. color [string type] libretto text color;
  15. align [string type] subtitle text alignment, 15.1. Left is left-aligned, center is center-aligned, and right is right-aligned;
#

a libretto

The properties are as follows:

  1. index [integer type] the index of libretto;
  2. inPoint [long integer type] the starting point of the libretto on the timeline, 2.1. The unit is microsecond;
  3. duration [long integer type] the duration of libretto, 3.1. The unit is microsecond;
  4. zValue [integer type] the level value of the libretto 4.1. Lyrics should be displayed on the top layer of all subtitles, the value is 100
  5. text [string type] libretto text; Examples are as follows:
<musicLyricsTracks>
  <musicLyricsTrack index="0" show="true" font="Noto Sans CJK JP" fontSize="54" fontSizeRatio="0.1" color="" align="center" styleId="5F772E33-FF29-47F9-AD23-8A46770EEB95" scaleX="1" scaleY="1" rotation="0" translationX="0" translationY="0">
  	<musicLyric index="0" inPoint="0" duration="5000000" text="2222" zValue="100"/>
  </musicLyricsTrack>
</musicLyricsTracks>
#

A collection of keyframes.

#

a keyframe parameter

The properties are as follows:

  1. time [long integer type] the timestamp of the key frame;
  2. type [string type] the parameter type of the key frame; 2.1. string, object
  3. key [string type] the parameter name of the key frame; 3.1. When the type is object, the key is region, ellipseRegion
  4. The parameter value of the value keyframe, 4.1. Different types of parameters have different value types; Examples are as follows:
<sticker type="general" inPoint="9153846" duration="5000000" id="B7B24515-86EE-460B-89C2-29689DA5AA9D">
  <keyFrames>
    <keyFrame time="0" type="float" key="Sticker TransX" value="0"/>
    <keyFrame time="0" type="float" key="Sticker TransY" value="0"/>
    <keyFrame time="0" type="float" key="Sticker Scale" value="1"/>
    <keyFrame time="0" type="float" key="Sticker RotZ" value="0"/>
  </keyFrames>
</sticker>

# template synthesis

# The overall structure and main labels of the project are as follows:

<?xml version="1.0" encoding="UTF-8"?>
<template>
  <footages>
    <footage/>
    ...
    <footage/>
  </footages>
  <captions>
    <caption/>
    ...
    <caption/>
  </captions>
  <music/>
</template>

# Label and attribute description

#

template

The properties are as follows:

  1. templateId [string type] template id
  2. sizeLevel [integer type] the resolution level of the synthesized film
  3. Logo [Boolean type] Whether the synthesized film has a watermark
  4. aspectRatio [string type] the resolution of the synthesized film
  5. duration [long integer type] the duration of synthesis into a film
  6. Whether nvenc [Boolean type] supports hard coding, 6.1. Default support Examples are as follows:
<template templateId="C68F79B1-74CB-4D51-8035-1EB2A522D4B7" sizeLevel="720" logo="true" duration="6560000" nvenc="true" aspectRatio="16:9"/>
#

collection of slots

#

A slot for replacing resources such as videos and pictures

The properties are as follows:

  1. footageId [string type] the id of the slot
  2. path [string type] the network path of the resource in the slot
  3. trimIn [long integer type] the starting point of resource trimming in the slot 3.1. The unit is microsecond
  4. volume [floating point type] the volume of resources in the slot
  5. zoom [floating point type] zoom value of resources in the slot 5.1. The zoom parameter is no longer processed, and it is fixed to 1 by default, for the compatibility of the synthesizer
  6. duration [long integer type] the duration of the slot
  7. indexes [string type] fragment information in the slot, including track index and fragment index Examples are as follows:
<footage footageId="footage1" path="https://alieasset.meishesdk.com/test/resource/video/2021/09/29/14540/92e5dc05-f7d6-4eda-af01-468998d8fd0e.mov" trimIn="0" volume="0" zoom="1" duration="60040000" indexs="0,0" />
#

A collection of subtitle slots

#

A subtitle slot to replace subtitles

The properties are as follows:

  1. text [string type] subtitle content
  2. id [string type] the id of the subtitle slot
  3. font [string type] subtitle font
  4. fontSize [floating point type] font size of the subtitle
  5. translationX [floating point type] the horizontal relative offset value of the subtitle
  6. translationY [floating point type] the vertical relative offset value of the subtitle
  7. color [string type] the color of the subtitle
  8. bold [Boolean type] Whether the subtitle is bold
  9. italic [Boolean type] Whether the subtitle is italic
  10. align [string type] subtitle alignment, 10.1. The six alignment values are mutually exclusive 10.2. Center is horizontally centered, left is aligned to the left, right is aligned to the right, top is aligned to the top, bottom is aligned to the bottom, and vCenter is vertically centered Examples are as follows:
<caption text="" id="0" font="PangMenZhengDao-3 [PangMenZhengDao-3]" translationX="500" translationY="500" fontSize="50" color="#ffff0000" bold="false" italic="false" align="center"/>
#

Music slot, replaceable music

The properties are as follows:

  1. type [string type] the type of music 1.1. The music that comes with the template template, the music replaced or added by the user
  2. path [string type] the path of the music, 2.1. When type is set to template, if the value of path is an empty string, it means that the music in the template is deleted
  3. trimIn [long integer type] the starting point of music trimming 3.1. The unit is microsecond
  4. duration [long integer type] the duration of the music 4.1. The unit is microsecond
  5. volume [floating point type] the volume of music Examples are as follows:
<music type="template" path="undefined" trimIn="0" duration="6560000" volume="1"/>