VOCommonPlayerSubtitle.h
1 /************************************************************************
2 VisualOn Proprietary
3 Copyright (c) 2012-2016, VisualOn, Inc. All Rights Reserved
4 
5 All data and information contained in or disclosed by this document are
6 confidential and proprietary information of VisualOn, Inc, and all rights
7 therein are expressly reserved. By accepting this material, the recipient
8 agrees that this material and the information contained therein are held
9 in confidence and in trust. The material may only be used and/or disclosed
10 as authorized in a license agreement controlling such use and disclosure.
11 ************************************************************************/
12 
13 #import <Foundation/Foundation.h>
14 
15 @protocol VOCommonPlayerSubtitle <NSObject>
16 
17 
25 - (VO_OSMP_RETURN_CODE) setSubtitlePath:(NSString *)filePath;
26 
27 
35 - (VO_OSMP_RETURN_CODE) enableSubtitle:(bool)value;
36 
37 
45 - (VO_OSMP_RETURN_CODE) setSubtitleFontColor:(int)color;
46 
47 
55 - (VO_OSMP_RETURN_CODE) setSubtitleFontOpacity:(int)alpha;
56 
57 
65 - (VO_OSMP_RETURN_CODE) setSubtitleFontSizeScale:(int)scale;
66 
67 
75 - (VO_OSMP_RETURN_CODE) setSubtitleFontBackgroundColor:(int)color;
76 
77 
85 - (VO_OSMP_RETURN_CODE) setSubtitleFontBackgroundOpacity:(int)alpha;
86 
87 
95 - (VO_OSMP_RETURN_CODE) setSubtitleWindowBackgroundColor:(int)color;
96 
97 
105 - (VO_OSMP_RETURN_CODE) setSubtitleWindowBackgroundOpacity:(int)alpha;
106 
107 
115 - (VO_OSMP_RETURN_CODE) setSubtitleFontItalic:(bool)enable;
116 
117 
125 - (VO_OSMP_RETURN_CODE) setSubtitleFontBold:(bool)enable;
126 
127 
135 - (VO_OSMP_RETURN_CODE) setSubtitleFontUnderline:(bool)enable;
136 
137 
145 - (VO_OSMP_RETURN_CODE) setSubtitleFontName:(NSString *)name;
146 
147 
155 - (VO_OSMP_RETURN_CODE) setSubtitleFontEdgeType:(int)type;
156 
157 
165 - (VO_OSMP_RETURN_CODE) setSubtitleFontEdgeColor:(int)color;
166 
167 
175 - (VO_OSMP_RETURN_CODE) setSubtitleFontEdgeOpacity:(int)alpha;
176 
177 
192 - (VO_OSMP_RETURN_CODE) setSubtitleBoundingBox:(int)topPercent leftPercent:(int)leftPercent bottomPercent:(int)bottomPercent rightPercent:(int)rightPercent;
193 
194 
203 - (VO_OSMP_RETURN_CODE) setSubtitleGravity:(VO_OSMP_HORIZONTAL)horizontal vertical:(VO_OSMP_VERTICAL)vertical;
204 
211 - (VO_OSMP_RETURN_CODE) setSubtitleTrim:(NSString *) trimChars;
212 
213 
219 - (VO_OSMP_RETURN_CODE) resetSubtitleParameter;
220 
221 
229 - (VO_OSMP_RETURN_CODE) enableSubtitleAutoAdjustment:(bool)value;
230 
231 
242 - (VO_OSMP_RETURN_CODE) previewSubtitle:(NSString *)sampleText view:(id)view;
243 
244 @end