Fixed directory and file structure for each SDK module in the documen…

…tation
VideoExpertsGroup · Feb 21, 2022 · 3bc5234 · 3bc5234
1 parent 10a8441
commit 3bc5234
Show file tree

Hide file tree

Showing 4 changed files with 77 additions and 11 deletions.
diff --git a/Documentation/iOS.EncoderSDK.md b/Documentation/iOS.EncoderSDK.md
@@ -33,12 +33,25 @@ VXG Mobile SDK structure:
 | Development environments | XCode |
 
 ## SDK structure
-The SDK package consists of the following files and folders:
-
-* lib (Library files to be linked to the application)
-    - MediaCaptureSDK.h 
-    - libMediaCaptureSDK.a 
-* src (Sample project to test the SDK)
+The SDK package consists of following files and folders:
+* dependencies/libraries    (Library files to be linked to the application and headers files)
+    - include/MediaCaptureSDK.h 
+    - libMediaCaptureSDK.a
+* dependencies/xcframeworks    (XCFrameworks files to be linked to the application)
+    - MediaCaptureSDK.xcframework 
+* docs	(Programmer’s Guide for VXG Encoder SDK)
+* src 	(Sample projects to test VXG Encoder SDK)
+
+The SDK also uses modules from a common folder for the all SDKs with next structure:
+* VXG.Media.SDK.iOS/dependencies/frameworks/universal    (Frameworks containing all platforms including emulator)
+    - ffmpeg.framework
+    - openssl.framework
+* VXG.Media.SDK.iOS/dependencies/frameworks/applestore    (Frameworks containing only platforms for real devices)
+    - ffmpeg.framework
+    - openssl.framework
+* VXG.Media.SDK.iOS/dependencies/xcframeworks    (XCFrameworks containing all supported platforms)
+    - ffmpeg.xcframework 
+    - openssl.xcframework 
 
 ## Block diagram
 

diff --git a/Documentation/iOS.PlayerSDK.md b/Documentation/iOS.PlayerSDK.md
@@ -34,16 +34,31 @@ VXG Mobile SDK structure:
 
 ## SDK structure
 The SDK package consists of following files and folders:
-
-* bin 	(Sample application package)
-* libs 	(Library files to be linked to the application and headers files)
-    - libMediaPlayerSDK.a
+* dependencies/libraries    (Library files to be linked to the application and headers files)
     - include/M3U8.h 
     - include/MediaPlayer.h 
     - include/MediaPlayerConfig.h 
+    - include/MediaPlayerPlaySegment.h 
+    - include/ONVIFDevice.h
+    - include/ONVIFDeviceManager.h
     - include/Thumbnailer.h 
     - include/ThumbnailerConfig.h
-* src 	(Sample project to test VXG Player SDK)
+    - libMediaPlayerSDK.a
+* dependencies/xcframeworks    (XCFrameworks files to be linked to the application)
+    - MediaPlayerSDK.xcframework 
+* docs	(Programmer’s Guide for VXG Player SDK)
+* src 	(Sample projects to test VXG Player SDK)
+
+The SDK also uses modules from a common folder for the all SDKs with next structure:
+* VXG.Media.SDK.iOS/dependencies/frameworks/universal    (Frameworks containing all platforms including emulator)
+    - ffmpeg.framework
+    - openssl.framework
+* VXG.Media.SDK.iOS/dependencies/frameworks/applestore    (Frameworks containing only platforms for real devices)
+    - ffmpeg.framework
+    - openssl.framework
+* VXG.Media.SDK.iOS/dependencies/xcframeworks    (XCFrameworks containing all supported platforms)
+    - ffmpeg.xcframework 
+    - openssl.xcframework 
 
 ## How to apply license key
 

diff --git a/Documentation/iOS.StreamingSDK.md b/Documentation/iOS.StreamingSDK.md
@@ -22,6 +22,43 @@ Cloud-Server Player is a tool for live and recorded video playback.
 
 IMPORTANT: Access token from the Dashboard should be used here
 
+## SDK structure
+The SDK package consists of following files and folders:
+* dependencies/libraries    (Library files to be linked to the application and headers files)
+    - include/CloudCommonSDK.h 
+    - include/CloudPlayerSDK.h
+    - include/CloudStreamerSDK.h
+    - include/CloudUtils.h
+    - libcloudsdk.a
+* dependencies/frameworks/universal    (Frameworks containing all platforms including emulator)
+    - cloudsdkcalendarview.framework
+    - cloudsdkplayerview.framework
+    - cloudsdktimelineview.framework
+* dependencies/frameworks/applestore    (Frameworks containing only platforms for real devices)
+    - cloudsdkcalendarview.framework
+    - cloudsdkplayerview.framework
+    - cloudsdktimelineview.framework
+* dependencies/xcframeworks    (XCFrameworks files to be linked to the application)
+    - cloudsdk.xcframework 
+    - cloudsdkcalendarview.xcframework 
+    - cloudsdkplayerview.xcframework 
+    - cloudsdktimelineview.xcframework 
+* src 	(Sample projects to test VXG Cloud SDK)
+
+The SDK also uses modules from a common folder for the all SDKs with next structure:
+* VXG.Media.SDK.iOS/dependencies/frameworks/universal    (Frameworks containing all platforms including emulator)
+    - SDWebImage.framework
+    - ffmpeg.framework
+    - openssl.framework
+* VXG.Media.SDK.iOS/dependencies/frameworks/applestore    (Frameworks containing only platforms for real devices)
+    - SDWebImage.framework
+    - ffmpeg.framework
+    - openssl.framework
+* VXG.Media.SDK.iOS/dependencies/xcframeworks    (XCFrameworks containing all supported platforms)
+    - SDWebImage.framework
+    - ffmpeg.xcframework 
+    - openssl.xcframework 
+
 #### Key features
 
 * Playback of live streams

diff --git a/README.md b/README.md
@@ -11,6 +11,7 @@ SDK consists of three modules:
 - Player SDK - for playback of media files and streams
 - Encoder SDK - for live video broadcasting from mobile device
 - Cloud SDK - module for playback from or streaming to VXG Cloud / VXG Server
+- Dependencies - common part for all SDKs. Contains reusable modules such as ffmpeg, openssl etc.
 
 Player module can be used for IPTV, iOS client of surveillance system, IP camera viewer, TV player, OTT clients and other kinds of applications with video playback. 
 Encoding module can be used for any kind of mobile video broadcasting: home surveillance, social networks, etc.